Class Layer2AttributesExtendedCommunityCaseBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.update.attributes.extended.communities.extended.community.Layer2AttributesExtendedCommunityCaseBuilder
@Generated("mdsal-binding-generator")
public class Layer2AttributesExtendedCommunityCaseBuilder
extends Object
Class that builds
Layer2AttributesExtendedCommunityCase
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:
Layer2AttributesExtendedCommunityCase createLayer2AttributesExtendedCommunityCase(int fooXyzzy, int barBaz) {
return new Layer2AttributesExtendedCommunityCaseBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Layer2AttributesExtendedCommunityCase, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedLayer2AttributesExtendedCommunity
.Construct a builder initialized with state from specifiedLayer2AttributesExtendedCommunityCase
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Layer2AttributesExtendedCommunityCase> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Layer2AttributesExtendedCommunityCase>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.build()
A newLayer2AttributesExtendedCommunityCase
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toLayer2AttributesExtendedCommunity.getLayer2AttributesExtendedCommunity()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Layer2AttributesExtendedCommunityCase>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toLayer2AttributesExtendedCommunity.getLayer2AttributesExtendedCommunity()
to the specified value.
-
Constructor Details
-
Layer2AttributesExtendedCommunityCaseBuilder
public Layer2AttributesExtendedCommunityCaseBuilder()Construct an empty builder. -
Layer2AttributesExtendedCommunityCaseBuilder
Construct a new builder initialized from specifiedLayer2AttributesExtendedCommunity
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.Layer2AttributesExtendedCommunity from which the builder should be initialized
-
Layer2AttributesExtendedCommunityCaseBuilder
Construct a builder initialized with state from specifiedLayer2AttributesExtendedCommunityCase
.- Parameters:
base
- Layer2AttributesExtendedCommunityCase from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getLayer2AttributesExtendedCommunity
Return current value associated with the property corresponding toLayer2AttributesExtendedCommunity.getLayer2AttributesExtendedCommunity()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Layer2AttributesExtendedCommunityCase>> 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
-
setLayer2AttributesExtendedCommunity
public Layer2AttributesExtendedCommunityCaseBuilder setLayer2AttributesExtendedCommunity(Layer2AttributesExtendedCommunity value) Set the property corresponding toLayer2AttributesExtendedCommunity.getLayer2AttributesExtendedCommunity()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Layer2AttributesExtendedCommunityCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Layer2AttributesExtendedCommunityCase> 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 Layer2AttributesExtendedCommunityCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Layer2AttributesExtendedCommunityCase>> 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
A newLayer2AttributesExtendedCommunityCase
instance.- Returns:
- A new
Layer2AttributesExtendedCommunityCase
instance.
-