Class PrefixAttributesCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.path.attribute.link.state.attribute.PrefixAttributesCaseBuilder
-
@Generated("mdsal-binding-generator") public class PrefixAttributesCaseBuilder extends Object
Class that buildsPrefixAttributesCase
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:
PrefixAttributesCase createPrefixAttributesCase(int fooXyzzy, int barBaz) { return new PrefixAttributesCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PrefixAttributesCase, 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:
PrefixAttributesCase
- 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 PrefixAttributesCaseBuilder()
Construct an empty builder.PrefixAttributesCaseBuilder(PrefixAttributesCase base)
Construct a builder initialized with state from specifiedPrefixAttributesCase
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PrefixAttributesCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PrefixAttributesCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixAttributesCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PrefixAttributesCase
build()
A newPrefixAttributesCase
instance.PrefixAttributes
getPrefixAttributes()
Return current value associated with the property corresponding toPrefixAttributesCase.getPrefixAttributes()
.PrefixAttributesCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixAttributesCase>> augmentationType)
Remove an augmentation from this builder's product.PrefixAttributesCaseBuilder
setPrefixAttributes(PrefixAttributes value)
Set the property corresponding toPrefixAttributesCase.getPrefixAttributes()
to the specified value.
-
-
-
Constructor Detail
-
PrefixAttributesCaseBuilder
public PrefixAttributesCaseBuilder()
Construct an empty builder.
-
PrefixAttributesCaseBuilder
public PrefixAttributesCaseBuilder(PrefixAttributesCase base)
Construct a builder initialized with state from specifiedPrefixAttributesCase
.- Parameters:
base
- PrefixAttributesCase from which the builder should be initialized
-
-
Method Detail
-
getPrefixAttributes
public PrefixAttributes getPrefixAttributes()
Return current value associated with the property corresponding toPrefixAttributesCase.getPrefixAttributes()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixAttributesCase>> 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
-
setPrefixAttributes
public PrefixAttributesCaseBuilder setPrefixAttributes(PrefixAttributes value)
Set the property corresponding toPrefixAttributesCase.getPrefixAttributes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PrefixAttributesCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PrefixAttributesCase> 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 PrefixAttributesCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PrefixAttributesCase>> 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 PrefixAttributesCase build()
A newPrefixAttributesCase
instance.- Returns:
- A new
PrefixAttributesCase
instance.
-
-