Class RedirectIpNhExtendedCommunityBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.flowspec.rev200120.redirect.ip.nh.extended.community.RedirectIpNhExtendedCommunityBuilder
-
@Generated("mdsal-binding-generator") public class RedirectIpNhExtendedCommunityBuilder extends Object
Class that buildsRedirectIpNhExtendedCommunity
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:
RedirectIpNhExtendedCommunity createRedirectIpNhExtendedCommunity(int fooXyzzy, int barBaz) { return new RedirectIpNhExtendedCommunityBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RedirectIpNhExtendedCommunity, 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:
RedirectIpNhExtendedCommunity
- 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 RedirectIpNhExtendedCommunityBuilder()
Construct an empty builder.RedirectIpNhExtendedCommunityBuilder(RedirectIpNhExtendedCommunity base)
Construct a builder initialized with state from specifiedRedirectIpNhExtendedCommunity
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RedirectIpNhExtendedCommunityBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RedirectIpNhExtendedCommunity> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RedirectIpNhExtendedCommunity>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull RedirectIpNhExtendedCommunity
build()
A newRedirectIpNhExtendedCommunity
instance.Boolean
getCopy()
Return current value associated with the property corresponding toRedirectIpNhExtendedCommunity.getCopy()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone
getNextHopAddress()
Return current value associated with the property corresponding toRedirectIpNhExtendedCommunity.getNextHopAddress()
.RedirectIpNhExtendedCommunityBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RedirectIpNhExtendedCommunity>> augmentationType)
Remove an augmentation from this builder's product.RedirectIpNhExtendedCommunityBuilder
setCopy(Boolean value)
Set the property corresponding toRedirectIpNhExtendedCommunity.getCopy()
to the specified value.RedirectIpNhExtendedCommunityBuilder
setNextHopAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
Set the property corresponding toRedirectIpNhExtendedCommunity.getNextHopAddress()
to the specified value.
-
-
-
Constructor Detail
-
RedirectIpNhExtendedCommunityBuilder
public RedirectIpNhExtendedCommunityBuilder()
Construct an empty builder.
-
RedirectIpNhExtendedCommunityBuilder
public RedirectIpNhExtendedCommunityBuilder(RedirectIpNhExtendedCommunity base)
Construct a builder initialized with state from specifiedRedirectIpNhExtendedCommunity
.- Parameters:
base
- RedirectIpNhExtendedCommunity from which the builder should be initialized
-
-
Method Detail
-
getCopy
public Boolean getCopy()
Return current value associated with the property corresponding toRedirectIpNhExtendedCommunity.getCopy()
.- Returns:
- current value
-
getNextHopAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getNextHopAddress()
Return current value associated with the property corresponding toRedirectIpNhExtendedCommunity.getNextHopAddress()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RedirectIpNhExtendedCommunity>> 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
-
setCopy
public RedirectIpNhExtendedCommunityBuilder setCopy(Boolean value)
Set the property corresponding toRedirectIpNhExtendedCommunity.getCopy()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNextHopAddress
public RedirectIpNhExtendedCommunityBuilder setNextHopAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
Set the property corresponding toRedirectIpNhExtendedCommunity.getNextHopAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public RedirectIpNhExtendedCommunityBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RedirectIpNhExtendedCommunity> 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 RedirectIpNhExtendedCommunityBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RedirectIpNhExtendedCommunity>> 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 RedirectIpNhExtendedCommunity build()
A newRedirectIpNhExtendedCommunity
instance.- Returns:
- A new
RedirectIpNhExtendedCommunity
instance.
-
-