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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Statement>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Statement,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class StatementBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Statement>
Class that buildsStatementBuilder
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:
StatementBuilder createTarget(int fooXyzzy, int barBaz) { return new StatementBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of StatementBuilder, 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 oportunities, 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:
StatementBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description StatementBuilder()
StatementBuilder(Statement base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StatementBuilder
addAugmentation(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)
Statement
build()
Actions
getActions()
Conditions
getConditions()
String
getName()
StatementKey
key()
StatementBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Statement>> augmentationType)
Remove an augmentation from this builder's product.StatementBuilder
setActions(Actions value)
StatementBuilder
setConditions(Conditions value)
StatementBuilder
setName(String value)
StatementBuilder
withKey(StatementKey key)
-
-
-
Constructor Detail
-
StatementBuilder
public StatementBuilder()
-
StatementBuilder
public StatementBuilder(Statement base)
-
-
Method Detail
-
key
public StatementKey key()
-
getActions
public Actions getActions()
-
getConditions
public Conditions getConditions()
-
getName
public String getName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Statement>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public StatementBuilder withKey(StatementKey key)
-
setActions
public StatementBuilder setActions(Actions value)
-
setConditions
public StatementBuilder setConditions(Conditions value)
-
setName
public StatementBuilder setName(String value)
-
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
public Statement build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Statement>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Statement,IllegalArgumentException>
-
-