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