Class MacMobilityExtendedCommunityBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.mac.mobility.extended.community.MacMobilityExtendedCommunityBuilder
@Generated("mdsal-binding-generator")
public class MacMobilityExtendedCommunityBuilder
extends Object
Class that builds
MacMobilityExtendedCommunity
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:
MacMobilityExtendedCommunity createMacMobilityExtendedCommunity(int fooXyzzy, int barBaz) {
return new MacMobilityExtendedCommunityBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of MacMobilityExtendedCommunity, 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 builder initialized with state from specifiedMacMobilityExtendedCommunity
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<MacMobilityExtendedCommunity> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MacMobilityExtendedCommunity>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull MacMobilityExtendedCommunity
build()
A newMacMobilityExtendedCommunity
instance.static @NonNull MacMobilityExtendedCommunity
empty()
Get empty instance of MacMobilityExtendedCommunity.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toMacMobilityExtendedCommunity.getSeqNumber()
.Return current value associated with the property corresponding toMacMobilityExtendedCommunity.getStatic()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MacMobilityExtendedCommunity>> augmentationType) Remove an augmentation from this builder's product.setSeqNumber
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toMacMobilityExtendedCommunity.getSeqNumber()
to the specified value.Set the property corresponding toMacMobilityExtendedCommunity.getStatic()
to the specified value.
-
Constructor Details
-
MacMobilityExtendedCommunityBuilder
public MacMobilityExtendedCommunityBuilder()Construct an empty builder. -
MacMobilityExtendedCommunityBuilder
Construct a builder initialized with state from specifiedMacMobilityExtendedCommunity
.- Parameters:
base
- MacMobilityExtendedCommunity from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of MacMobilityExtendedCommunity.- Returns:
- An empty
MacMobilityExtendedCommunity
-
getSeqNumber
public org.opendaylight.yangtools.yang.common.Uint32 getSeqNumber()Return current value associated with the property corresponding toMacMobilityExtendedCommunity.getSeqNumber()
.- Returns:
- current value
-
getStatic
Return current value associated with the property corresponding toMacMobilityExtendedCommunity.getStatic()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MacMobilityExtendedCommunity>> 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
-
setSeqNumber
public MacMobilityExtendedCommunityBuilder setSeqNumber(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toMacMobilityExtendedCommunity.getSeqNumber()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setStatic
Set the property corresponding toMacMobilityExtendedCommunity.getStatic()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MacMobilityExtendedCommunityBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MacMobilityExtendedCommunity> 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 MacMobilityExtendedCommunityBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MacMobilityExtendedCommunity>> 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 newMacMobilityExtendedCommunity
instance.- Returns:
- A new
MacMobilityExtendedCommunity
instance.
-