Class StatementsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.routing.policy.top.routing.policy.policy.definitions.policy.definition.StatementsBuilder
-
@Generated("mdsal-binding-generator") public class StatementsBuilder extends Object
Class that buildsStatements
instances. Overall design of the class is that of a fluent interface, where method chaining is used.In general, this class is supposed to be used like this template:
Statements createStatements(int fooXyzzy, int barBaz) { return new StatementsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Statements, as instances can be freely passed around without worrying about synchronization issues.
As a side note: method chaining results in:
- very efficient Java bytecode, as the method invocation result, in this case the Builder reference, is
on the stack, so further method invocations just need to fill method arguments for the next method
invocation, which is terminated by
build()
, which is then returned from the method - better understanding by humans, as the scope of mutable state (the builder) is kept to a minimum and is very localized
- better optimization opportunities, as the object scope is minimized in terms of invocation (rather than method) stack, making escape analysis a lot easier. Given enough compiler (JIT/AOT) prowess, the cost of th builder object can be completely eliminated
- See Also:
Statements
- very efficient Java bytecode, as the method invocation result, in this case the Builder reference, is
on the stack, so further method invocations just need to fill method arguments for the next method
invocation, which is terminated by
-
-
Constructor Summary
Constructors Constructor Description StatementsBuilder()
Construct an empty builder.StatementsBuilder(Statements base)
Construct a builder initialized with state from specifiedStatements
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StatementsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Statements> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Statements>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Statements
build()
A newStatements
instance.List<Statement>
getStatement()
Return current value associated with the property corresponding toStatements.getStatement()
.StatementsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Statements>> augmentationType)
Remove an augmentation from this builder's product.StatementsBuilder
setStatement(List<Statement> values)
Set the property corresponding toStatements.getStatement()
to the specified value.
-
-
-
Constructor Detail
-
StatementsBuilder
public StatementsBuilder()
Construct an empty builder.
-
StatementsBuilder
public StatementsBuilder(Statements base)
Construct a builder initialized with state from specifiedStatements
.- Parameters:
base
- Statements from which the builder should be initialized
-
-
Method Detail
-
getStatement
public List<Statement> getStatement()
Return current value associated with the property corresponding toStatements.getStatement()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Statements>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setStatement
public StatementsBuilder setStatement(List<Statement> values)
Set the property corresponding toStatements.getStatement()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public StatementsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Statements> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public StatementsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Statements>> augmentationType)
Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.- Parameters:
augmentationType
- augmentation type to be removed- Returns:
- this builder
-
build
public @NonNull Statements build()
A newStatements
instance.- Returns:
- A new
Statements
instance.
-
-