Class RouteTargetExtendedCommunityBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.route.target.extended.community.grouping.RouteTargetExtendedCommunityBuilder
-
@Generated("mdsal-binding-generator") public class RouteTargetExtendedCommunityBuilder extends Object
Class that buildsRouteTargetExtendedCommunity
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:
RouteTargetExtendedCommunity createRouteTargetExtendedCommunity(int fooXyzzy, int barBaz) { return new RouteTargetExtendedCommunityBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RouteTargetExtendedCommunity, 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:
RouteTargetExtendedCommunity
- 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
-
-
Constructor Summary
Constructors Constructor Description RouteTargetExtendedCommunityBuilder()
Construct an empty builder.RouteTargetExtendedCommunityBuilder(RouteTargetExtendedCommunity base)
Construct a builder initialized with state from specifiedRouteTargetExtendedCommunity
.RouteTargetExtendedCommunityBuilder(RouteTarget arg)
Construct a new builder initialized from specifiedRouteTarget
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RouteTargetExtendedCommunityBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RouteTargetExtendedCommunity> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteTargetExtendedCommunity>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull RouteTargetExtendedCommunity
build()
A newRouteTargetExtendedCommunity
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.ShortAsNumber
getGlobalAdministrator()
Return current value associated with the property corresponding toRouteTargetExtendedCommunity.getGlobalAdministrator()
.byte[]
getLocalAdministrator()
Return current value associated with the property corresponding toRouteTargetExtendedCommunity.getLocalAdministrator()
.RouteTargetExtendedCommunityBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteTargetExtendedCommunity>> augmentationType)
Remove an augmentation from this builder's product.RouteTargetExtendedCommunityBuilder
setGlobalAdministrator(ShortAsNumber value)
Set the property corresponding toRouteTargetExtendedCommunity.getGlobalAdministrator()
to the specified value.RouteTargetExtendedCommunityBuilder
setLocalAdministrator(byte[] value)
Set the property corresponding toRouteTargetExtendedCommunity.getLocalAdministrator()
to the specified value.
-
-
-
Constructor Detail
-
RouteTargetExtendedCommunityBuilder
public RouteTargetExtendedCommunityBuilder()
Construct an empty builder.
-
RouteTargetExtendedCommunityBuilder
public RouteTargetExtendedCommunityBuilder(RouteTarget arg)
Construct a new builder initialized from specifiedRouteTarget
.- Parameters:
arg
- RouteTarget from which the builder should be initialized
-
RouteTargetExtendedCommunityBuilder
public RouteTargetExtendedCommunityBuilder(RouteTargetExtendedCommunity base)
Construct a builder initialized with state from specifiedRouteTargetExtendedCommunity
.- Parameters:
base
- RouteTargetExtendedCommunity from which the builder should be initialized
-
-
Method Detail
-
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
-
getGlobalAdministrator
public ShortAsNumber getGlobalAdministrator()
Return current value associated with the property corresponding toRouteTargetExtendedCommunity.getGlobalAdministrator()
.- Returns:
- current value
-
getLocalAdministrator
public byte[] getLocalAdministrator()
Return current value associated with the property corresponding toRouteTargetExtendedCommunity.getLocalAdministrator()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteTargetExtendedCommunity>> 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 RouteTargetExtendedCommunityBuilder setGlobalAdministrator(ShortAsNumber value)
Set the property corresponding toRouteTargetExtendedCommunity.getGlobalAdministrator()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLocalAdministrator
public RouteTargetExtendedCommunityBuilder setLocalAdministrator(byte[] value)
Set the property corresponding toRouteTargetExtendedCommunity.getLocalAdministrator()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public RouteTargetExtendedCommunityBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RouteTargetExtendedCommunity> 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 RouteTargetExtendedCommunityBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteTargetExtendedCommunity>> 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 @NonNull RouteTargetExtendedCommunity build()
A newRouteTargetExtendedCommunity
instance.- Returns:
- A new
RouteTargetExtendedCommunity
instance.
-
-