Class EsiLabelExtendedCommunityBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.esi.label.extended.community.EsiLabelExtendedCommunityBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<EsiLabelExtendedCommunity>
,org.opendaylight.yangtools.concepts.CheckedBuilder<EsiLabelExtendedCommunity,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class EsiLabelExtendedCommunityBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<EsiLabelExtendedCommunity>
Class that buildsEsiLabelExtendedCommunity
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:
EsiLabelExtendedCommunity createEsiLabelExtendedCommunity(int fooXyzzy, int barBaz) { return new EsiLabelExtendedCommunityBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of EsiLabelExtendedCommunity, 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:
EsiLabelExtendedCommunity
,Builder
-
-
Constructor Summary
Constructors Constructor Description EsiLabelExtendedCommunityBuilder()
EsiLabelExtendedCommunityBuilder(EsiLabelExtendedCommunity base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EsiLabelExtendedCommunityBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EsiLabelExtendedCommunity> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EsiLabelExtendedCommunity>>
E$$augmentation(Class<E$$> augmentationType)
EsiLabelExtendedCommunity
build()
MplsLabel
getEsiLabel()
Boolean
getSingleActiveMode()
EsiLabelExtendedCommunityBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EsiLabelExtendedCommunity>> augmentationType)
Remove an augmentation from this builder's product.EsiLabelExtendedCommunityBuilder
setEsiLabel(MplsLabel value)
EsiLabelExtendedCommunityBuilder
setSingleActiveMode(Boolean value)
-
-
-
Constructor Detail
-
EsiLabelExtendedCommunityBuilder
public EsiLabelExtendedCommunityBuilder()
-
EsiLabelExtendedCommunityBuilder
public EsiLabelExtendedCommunityBuilder(EsiLabelExtendedCommunity base)
-
-
Method Detail
-
getEsiLabel
public MplsLabel getEsiLabel()
-
getSingleActiveMode
public Boolean getSingleActiveMode()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EsiLabelExtendedCommunity>> E$$ augmentation(Class<E$$> augmentationType)
-
setEsiLabel
public EsiLabelExtendedCommunityBuilder setEsiLabel(MplsLabel value)
-
setSingleActiveMode
public EsiLabelExtendedCommunityBuilder setSingleActiveMode(Boolean value)
-
addAugmentation
public EsiLabelExtendedCommunityBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EsiLabelExtendedCommunity> 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 EsiLabelExtendedCommunityBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EsiLabelExtendedCommunity>> 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 EsiLabelExtendedCommunity build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<EsiLabelExtendedCommunity>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<EsiLabelExtendedCommunity,IllegalArgumentException>
-
-