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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Layer2AttributesExtendedCommunity>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Layer2AttributesExtendedCommunity,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class Layer2AttributesExtendedCommunityBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Layer2AttributesExtendedCommunity>
Class that buildsLayer2AttributesExtendedCommunityBuilder
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:
Layer2AttributesExtendedCommunityBuilder createTarget(int fooXyzzy, int barBaz) { return new Layer2AttributesExtendedCommunityBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Layer2AttributesExtendedCommunityBuilder, 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 oportunities, 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:
Layer2AttributesExtendedCommunityBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description Layer2AttributesExtendedCommunityBuilder()
Layer2AttributesExtendedCommunityBuilder(Layer2AttributesExtendedCommunity base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated 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)
Layer2AttributesExtendedCommunity
build()
Boolean
getBackupPe()
Boolean
getControlWord()
org.opendaylight.yangtools.yang.common.Uint16
getL2Mtu()
OperationalMode
getModeOfOperation()
NormalizationType
getOperatingPer()
Boolean
getPrimaryPe()
Boolean
isBackupPe()
Deprecated, for removal: This API element is subject to removal in a future version.Boolean
isControlWord()
Deprecated, for removal: This API element is subject to removal in a future version.Boolean
isPrimaryPe()
Deprecated, for removal: This API element is subject to removal in a future version.Layer2AttributesExtendedCommunityBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Layer2AttributesExtendedCommunity>> augmentationType)
Remove an augmentation from this builder's product.Layer2AttributesExtendedCommunityBuilder
setBackupPe(Boolean value)
Layer2AttributesExtendedCommunityBuilder
setControlWord(Boolean value)
Layer2AttributesExtendedCommunityBuilder
setL2Mtu(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetL2Mtu(Uint16)
instead.Layer2AttributesExtendedCommunityBuilder
setL2Mtu(org.opendaylight.yangtools.yang.common.Uint16 value)
Layer2AttributesExtendedCommunityBuilder
setModeOfOperation(OperationalMode value)
Layer2AttributesExtendedCommunityBuilder
setOperatingPer(NormalizationType value)
Layer2AttributesExtendedCommunityBuilder
setPrimaryPe(Boolean value)
-
-
-
Constructor Detail
-
Layer2AttributesExtendedCommunityBuilder
public Layer2AttributesExtendedCommunityBuilder()
-
Layer2AttributesExtendedCommunityBuilder
public Layer2AttributesExtendedCommunityBuilder(Layer2AttributesExtendedCommunity base)
-
-
Method Detail
-
getBackupPe
public Boolean getBackupPe()
-
isBackupPe
@Deprecated(forRemoval=true) public final Boolean isBackupPe()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getControlWord
public Boolean getControlWord()
-
isControlWord
@Deprecated(forRemoval=true) public final Boolean isControlWord()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getL2Mtu
public org.opendaylight.yangtools.yang.common.Uint16 getL2Mtu()
-
getModeOfOperation
public OperationalMode getModeOfOperation()
-
getOperatingPer
public NormalizationType getOperatingPer()
-
getPrimaryPe
public Boolean getPrimaryPe()
-
isPrimaryPe
@Deprecated(forRemoval=true) public final Boolean isPrimaryPe()
Deprecated, for removal: This API element is subject to removal in a future version.
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Layer2AttributesExtendedCommunity>> E$$ augmentation(Class<E$$> augmentationType)
-
setBackupPe
public Layer2AttributesExtendedCommunityBuilder setBackupPe(Boolean value)
-
setControlWord
public Layer2AttributesExtendedCommunityBuilder setControlWord(Boolean value)
-
setL2Mtu
public Layer2AttributesExtendedCommunityBuilder setL2Mtu(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setL2Mtu
@Deprecated(forRemoval=true) public Layer2AttributesExtendedCommunityBuilder setL2Mtu(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetL2Mtu(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setModeOfOperation
public Layer2AttributesExtendedCommunityBuilder setModeOfOperation(OperationalMode value)
-
setOperatingPer
public Layer2AttributesExtendedCommunityBuilder setOperatingPer(NormalizationType value)
-
setPrimaryPe
public Layer2AttributesExtendedCommunityBuilder setPrimaryPe(Boolean value)
-
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 Layer2AttributesExtendedCommunity build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Layer2AttributesExtendedCommunity>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Layer2AttributesExtendedCommunity,IllegalArgumentException>
-
-