Class PolicyDefinitionBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.routing.policy.top.routing.policy.policy.definitions.PolicyDefinitionBuilder
-
@Generated("mdsal-binding-generator") public class PolicyDefinitionBuilder extends Object
Class that buildsPolicyDefinition
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:
PolicyDefinition createPolicyDefinition(int fooXyzzy, int barBaz) { return new PolicyDefinitionBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PolicyDefinition, 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:
PolicyDefinition
- 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 PolicyDefinitionBuilder()
Construct an empty builder.PolicyDefinitionBuilder(PolicyDefinition base)
Construct a builder initialized with state from specifiedPolicyDefinition
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PolicyDefinitionBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PolicyDefinition> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PolicyDefinition>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PolicyDefinition
build()
A newPolicyDefinition
instance.String
getName()
Return current value associated with the property corresponding toPolicyDefinition.getName()
.Statements
getStatements()
Return current value associated with the property corresponding toPolicyDefinition.getStatements()
.PolicyDefinitionKey
key()
Return current value associated with the property corresponding toPolicyDefinition.key()
.PolicyDefinitionBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PolicyDefinition>> augmentationType)
Remove an augmentation from this builder's product.PolicyDefinitionBuilder
setName(String value)
Set the property corresponding toPolicyDefinition.getName()
to the specified value.PolicyDefinitionBuilder
setStatements(Statements value)
Set the property corresponding toPolicyDefinition.getStatements()
to the specified value.PolicyDefinitionBuilder
withKey(PolicyDefinitionKey key)
-
-
-
Constructor Detail
-
PolicyDefinitionBuilder
public PolicyDefinitionBuilder()
Construct an empty builder.
-
PolicyDefinitionBuilder
public PolicyDefinitionBuilder(PolicyDefinition base)
Construct a builder initialized with state from specifiedPolicyDefinition
.- Parameters:
base
- PolicyDefinition from which the builder should be initialized
-
-
Method Detail
-
key
public PolicyDefinitionKey key()
Return current value associated with the property corresponding toPolicyDefinition.key()
.- Returns:
- current value
-
getName
public String getName()
Return current value associated with the property corresponding toPolicyDefinition.getName()
.- Returns:
- current value
-
getStatements
public Statements getStatements()
Return current value associated with the property corresponding toPolicyDefinition.getStatements()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PolicyDefinition>> 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
public PolicyDefinitionBuilder withKey(PolicyDefinitionKey key)
-
setName
public PolicyDefinitionBuilder setName(String value)
Set the property corresponding toPolicyDefinition.getName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setStatements
public PolicyDefinitionBuilder setStatements(Statements value)
Set the property corresponding toPolicyDefinition.getStatements()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PolicyDefinitionBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PolicyDefinition> 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 PolicyDefinitionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PolicyDefinition>> 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 PolicyDefinition build()
A newPolicyDefinition
instance.- Returns:
- A new
PolicyDefinition
instance.
-
-