Class StatementBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.routing.policy.top.routing.policy.policy.definitions.policy.definition.statements.StatementBuilder
Class that builds
Statement
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:
Statement createStatement(int fooXyzzy, int barBaz) {
return new StatementBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Statement, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.StatementBuilder
(Statement base) Construct a builder initialized with state from specifiedStatement
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Statement> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Statement>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Statement
build()
A newStatement
instance.Return current value associated with the property corresponding toStatement.getActions()
.Return current value associated with the property corresponding toStatement.getConditions()
.getName()
Return current value associated with the property corresponding toStatement.getName()
.key()
Return current value associated with the property corresponding toStatement.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Statement>> augmentationType) Remove an augmentation from this builder's product.setActions
(Actions value) Set the property corresponding toStatement.getActions()
to the specified value.setConditions
(Conditions value) Set the property corresponding toStatement.getConditions()
to the specified value.Set the property corresponding toStatement.getName()
to the specified value.withKey
(StatementKey key) Set the key value corresponding toStatement.key()
to the specified value.
-
Constructor Details
-
StatementBuilder
public StatementBuilder()Construct an empty builder. -
StatementBuilder
Construct a builder initialized with state from specifiedStatement
.- Parameters:
base
- Statement from which the builder should be initialized
-
-
Method Details
-
key
Return current value associated with the property corresponding toStatement.key()
.- Returns:
- current value
-
getActions
Return current value associated with the property corresponding toStatement.getActions()
.- Returns:
- current value
-
getConditions
Return current value associated with the property corresponding toStatement.getConditions()
.- Returns:
- current value
-
getName
Return current value associated with the property corresponding toStatement.getName()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Statement>> 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
-
withKey
Set the key value corresponding toStatement.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setActions
Set the property corresponding toStatement.getActions()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setConditions
Set the property corresponding toStatement.getConditions()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setName
Set the property corresponding toStatement.getName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public StatementBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Statement> 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 StatementBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Statement>> 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
A newStatement
instance.- Returns:
- A new
Statement
instance.
-