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