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