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