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