Class Layer2AttributesExtendedCommunityBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.layer._2.attributes.extended.community.Layer2AttributesExtendedCommunityBuilder
-
@Generated("mdsal-binding-generator") public class Layer2AttributesExtendedCommunityBuilder extends Object
Class that buildsLayer2AttributesExtendedCommunity
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:
Layer2AttributesExtendedCommunity createLayer2AttributesExtendedCommunity(int fooXyzzy, int barBaz) { return new Layer2AttributesExtendedCommunityBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Layer2AttributesExtendedCommunity, 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:
Layer2AttributesExtendedCommunity
- 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 Layer2AttributesExtendedCommunityBuilder()
Construct an empty builder.Layer2AttributesExtendedCommunityBuilder(Layer2AttributesExtendedCommunity base)
Construct a builder initialized with state from specifiedLayer2AttributesExtendedCommunity
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Layer2AttributesExtendedCommunityBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Layer2AttributesExtendedCommunity> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Layer2AttributesExtendedCommunity>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Layer2AttributesExtendedCommunity
build()
A newLayer2AttributesExtendedCommunity
instance.Boolean
getBackupPe()
Return current value associated with the property corresponding toLayer2AttributesExtendedCommunity.getBackupPe()
.Boolean
getControlWord()
Return current value associated with the property corresponding toLayer2AttributesExtendedCommunity.getControlWord()
.org.opendaylight.yangtools.yang.common.Uint16
getL2Mtu()
Return current value associated with the property corresponding toLayer2AttributesExtendedCommunity.getL2Mtu()
.OperationalMode
getModeOfOperation()
Return current value associated with the property corresponding toLayer2AttributesExtendedCommunity.getModeOfOperation()
.NormalizationType
getOperatingPer()
Return current value associated with the property corresponding toLayer2AttributesExtendedCommunity.getOperatingPer()
.Boolean
getPrimaryPe()
Return current value associated with the property corresponding toLayer2AttributesExtendedCommunity.getPrimaryPe()
.Layer2AttributesExtendedCommunityBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Layer2AttributesExtendedCommunity>> augmentationType)
Remove an augmentation from this builder's product.Layer2AttributesExtendedCommunityBuilder
setBackupPe(Boolean value)
Set the property corresponding toLayer2AttributesExtendedCommunity.getBackupPe()
to the specified value.Layer2AttributesExtendedCommunityBuilder
setControlWord(Boolean value)
Set the property corresponding toLayer2AttributesExtendedCommunity.getControlWord()
to the specified value.Layer2AttributesExtendedCommunityBuilder
setL2Mtu(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toLayer2AttributesExtendedCommunity.getL2Mtu()
to the specified value.Layer2AttributesExtendedCommunityBuilder
setModeOfOperation(OperationalMode value)
Set the property corresponding toLayer2AttributesExtendedCommunity.getModeOfOperation()
to the specified value.Layer2AttributesExtendedCommunityBuilder
setOperatingPer(NormalizationType value)
Set the property corresponding toLayer2AttributesExtendedCommunity.getOperatingPer()
to the specified value.Layer2AttributesExtendedCommunityBuilder
setPrimaryPe(Boolean value)
Set the property corresponding toLayer2AttributesExtendedCommunity.getPrimaryPe()
to the specified value.
-
-
-
Constructor Detail
-
Layer2AttributesExtendedCommunityBuilder
public Layer2AttributesExtendedCommunityBuilder()
Construct an empty builder.
-
Layer2AttributesExtendedCommunityBuilder
public Layer2AttributesExtendedCommunityBuilder(Layer2AttributesExtendedCommunity base)
Construct a builder initialized with state from specifiedLayer2AttributesExtendedCommunity
.- Parameters:
base
- Layer2AttributesExtendedCommunity from which the builder should be initialized
-
-
Method Detail
-
getBackupPe
public Boolean getBackupPe()
Return current value associated with the property corresponding toLayer2AttributesExtendedCommunity.getBackupPe()
.- Returns:
- current value
-
getControlWord
public Boolean getControlWord()
Return current value associated with the property corresponding toLayer2AttributesExtendedCommunity.getControlWord()
.- Returns:
- current value
-
getL2Mtu
public org.opendaylight.yangtools.yang.common.Uint16 getL2Mtu()
Return current value associated with the property corresponding toLayer2AttributesExtendedCommunity.getL2Mtu()
.- Returns:
- current value
-
getModeOfOperation
public OperationalMode getModeOfOperation()
Return current value associated with the property corresponding toLayer2AttributesExtendedCommunity.getModeOfOperation()
.- Returns:
- current value
-
getOperatingPer
public NormalizationType getOperatingPer()
Return current value associated with the property corresponding toLayer2AttributesExtendedCommunity.getOperatingPer()
.- Returns:
- current value
-
getPrimaryPe
public Boolean getPrimaryPe()
Return current value associated with the property corresponding toLayer2AttributesExtendedCommunity.getPrimaryPe()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Layer2AttributesExtendedCommunity>> 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
-
setBackupPe
public Layer2AttributesExtendedCommunityBuilder setBackupPe(Boolean value)
Set the property corresponding toLayer2AttributesExtendedCommunity.getBackupPe()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setControlWord
public Layer2AttributesExtendedCommunityBuilder setControlWord(Boolean value)
Set the property corresponding toLayer2AttributesExtendedCommunity.getControlWord()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setL2Mtu
public Layer2AttributesExtendedCommunityBuilder setL2Mtu(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toLayer2AttributesExtendedCommunity.getL2Mtu()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setModeOfOperation
public Layer2AttributesExtendedCommunityBuilder setModeOfOperation(OperationalMode value)
Set the property corresponding toLayer2AttributesExtendedCommunity.getModeOfOperation()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOperatingPer
public Layer2AttributesExtendedCommunityBuilder setOperatingPer(NormalizationType value)
Set the property corresponding toLayer2AttributesExtendedCommunity.getOperatingPer()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPrimaryPe
public Layer2AttributesExtendedCommunityBuilder setPrimaryPe(Boolean value)
Set the property corresponding toLayer2AttributesExtendedCommunity.getPrimaryPe()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Layer2AttributesExtendedCommunityBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Layer2AttributesExtendedCommunity> 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 Layer2AttributesExtendedCommunityBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Layer2AttributesExtendedCommunity>> 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 Layer2AttributesExtendedCommunity build()
A newLayer2AttributesExtendedCommunity
instance.- Returns:
- A new
Layer2AttributesExtendedCommunity
instance.
-
-