Class EncapsulationExtendedCommunityBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.extended.community.extended.community.encapsulation._case.EncapsulationExtendedCommunityBuilder
-
@Generated("mdsal-binding-generator") public class EncapsulationExtendedCommunityBuilder extends Object
Class that buildsEncapsulationExtendedCommunity
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:
EncapsulationExtendedCommunity createEncapsulationExtendedCommunity(int fooXyzzy, int barBaz) { return new EncapsulationExtendedCommunityBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of EncapsulationExtendedCommunity, 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:
EncapsulationExtendedCommunity
- 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 EncapsulationExtendedCommunityBuilder()
Construct an empty builder.EncapsulationExtendedCommunityBuilder(EncapsulationExtendedCommunity arg)
Construct a new builder initialized from specifiedEncapsulationExtendedCommunity
.EncapsulationExtendedCommunityBuilder(EncapsulationExtendedCommunity base)
Construct a builder initialized with state from specifiedEncapsulationExtendedCommunity
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EncapsulationExtendedCommunityBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EncapsulationExtendedCommunity> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EncapsulationExtendedCommunity>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull EncapsulationExtendedCommunity
build()
A newEncapsulationExtendedCommunity
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.EncapsulationTunnelType
getTunnelType()
Return current value associated with the property corresponding toEncapsulationExtendedCommunity.getTunnelType()
.EncapsulationExtendedCommunityBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EncapsulationExtendedCommunity>> augmentationType)
Remove an augmentation from this builder's product.EncapsulationExtendedCommunityBuilder
setTunnelType(EncapsulationTunnelType value)
Set the property corresponding toEncapsulationExtendedCommunity.getTunnelType()
to the specified value.
-
-
-
Constructor Detail
-
EncapsulationExtendedCommunityBuilder
public EncapsulationExtendedCommunityBuilder()
Construct an empty builder.
-
EncapsulationExtendedCommunityBuilder
public EncapsulationExtendedCommunityBuilder(EncapsulationExtendedCommunity arg)
Construct a new builder initialized from specifiedEncapsulationExtendedCommunity
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.EncapsulationExtendedCommunity from which the builder should be initialized
-
EncapsulationExtendedCommunityBuilder
public EncapsulationExtendedCommunityBuilder(EncapsulationExtendedCommunity base)
Construct a builder initialized with state from specifiedEncapsulationExtendedCommunity
.- Parameters:
base
- EncapsulationExtendedCommunity from which the builder should be initialized
-
-
Method Detail
-
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
-
getTunnelType
public EncapsulationTunnelType getTunnelType()
Return current value associated with the property corresponding toEncapsulationExtendedCommunity.getTunnelType()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EncapsulationExtendedCommunity>> 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
-
setTunnelType
public EncapsulationExtendedCommunityBuilder setTunnelType(EncapsulationTunnelType value)
Set the property corresponding toEncapsulationExtendedCommunity.getTunnelType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public EncapsulationExtendedCommunityBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EncapsulationExtendedCommunity> 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 EncapsulationExtendedCommunityBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EncapsulationExtendedCommunity>> 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 EncapsulationExtendedCommunity build()
A newEncapsulationExtendedCommunity
instance.- Returns:
- A new
EncapsulationExtendedCommunity
instance.
-
-