Class Inet4SpecificExtendedCommunityCommonBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.inet4.specific.extended.community.common.Inet4SpecificExtendedCommunityCommonBuilder
@Generated("mdsal-binding-generator")
public class Inet4SpecificExtendedCommunityCommonBuilder
extends Object
Class that builds
Inet4SpecificExtendedCommunityCommon
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:
Inet4SpecificExtendedCommunityCommon createInet4SpecificExtendedCommunityCommon(int fooXyzzy, int barBaz) {
return new Inet4SpecificExtendedCommunityCommonBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Inet4SpecificExtendedCommunityCommon, 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 specifiedInet4SpecificExtendedCommunityCommon
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Inet4SpecificExtendedCommunityCommon> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Inet4SpecificExtendedCommunityCommon>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Inet4SpecificExtendedCommunityCommon
build()
A newInet4SpecificExtendedCommunityCommon
instance.static @NonNull Inet4SpecificExtendedCommunityCommon
empty()
Get empty instance of Inet4SpecificExtendedCommunityCommon.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone
Return current value associated with the property corresponding toInet4SpecificExtendedCommunityCommon.getGlobalAdministrator()
.byte[]
Return current value associated with the property corresponding toInet4SpecificExtendedCommunityCommon.getLocalAdministrator()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Inet4SpecificExtendedCommunityCommon>> augmentationType) Remove an augmentation from this builder's product.setGlobalAdministrator
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value) Set the property corresponding toInet4SpecificExtendedCommunityCommon.getGlobalAdministrator()
to the specified value.setLocalAdministrator
(byte[] value) Set the property corresponding toInet4SpecificExtendedCommunityCommon.getLocalAdministrator()
to the specified value.
-
Constructor Details
-
Inet4SpecificExtendedCommunityCommonBuilder
public Inet4SpecificExtendedCommunityCommonBuilder()Construct an empty builder. -
Inet4SpecificExtendedCommunityCommonBuilder
Construct a builder initialized with state from specifiedInet4SpecificExtendedCommunityCommon
.- Parameters:
base
- Inet4SpecificExtendedCommunityCommon from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of Inet4SpecificExtendedCommunityCommon.- Returns:
- An empty
Inet4SpecificExtendedCommunityCommon
-
getGlobalAdministrator
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getGlobalAdministrator()Return current value associated with the property corresponding toInet4SpecificExtendedCommunityCommon.getGlobalAdministrator()
.- Returns:
- current value
-
getLocalAdministrator
public byte[] getLocalAdministrator()Return current value associated with the property corresponding toInet4SpecificExtendedCommunityCommon.getLocalAdministrator()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Inet4SpecificExtendedCommunityCommon>> 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
-
setGlobalAdministrator
public Inet4SpecificExtendedCommunityCommonBuilder setGlobalAdministrator(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value) Set the property corresponding toInet4SpecificExtendedCommunityCommon.getGlobalAdministrator()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLocalAdministrator
Set the property corresponding toInet4SpecificExtendedCommunityCommon.getLocalAdministrator()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Inet4SpecificExtendedCommunityCommonBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Inet4SpecificExtendedCommunityCommon> 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 Inet4SpecificExtendedCommunityCommonBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Inet4SpecificExtendedCommunityCommon>> 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 newInet4SpecificExtendedCommunityCommon
instance.- Returns:
- A new
Inet4SpecificExtendedCommunityCommon
instance.
-