Class ExcludeRouteBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.path.computation.rev220324.path.constraints.ExcludeRouteBuilder
-
@Generated("mdsal-binding-generator") public class ExcludeRouteBuilder extends Object
Class that buildsExcludeRoute
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:
ExcludeRoute createExcludeRoute(int fooXyzzy, int barBaz) { return new ExcludeRouteBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ExcludeRoute, 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:
ExcludeRoute
- 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 ExcludeRouteBuilder()
Construct an empty builder.ExcludeRouteBuilder(ExcludeRoute base)
Construct a builder initialized with state from specifiedExcludeRoute
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ExcludeRouteBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ExcludeRoute> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExcludeRoute>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull ExcludeRoute
build()
A newExcludeRoute
instance.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address
getIpv4()
Return current value associated with the property corresponding toExcludeRoute.getIpv4()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address
getIpv6()
Return current value associated with the property corresponding toExcludeRoute.getIpv6()
.ExcludeRouteBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExcludeRoute>> augmentationType)
Remove an augmentation from this builder's product.ExcludeRouteBuilder
setIpv4(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)
Set the property corresponding toExcludeRoute.getIpv4()
to the specified value.ExcludeRouteBuilder
setIpv6(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value)
Set the property corresponding toExcludeRoute.getIpv6()
to the specified value.
-
-
-
Constructor Detail
-
ExcludeRouteBuilder
public ExcludeRouteBuilder()
Construct an empty builder.
-
ExcludeRouteBuilder
public ExcludeRouteBuilder(ExcludeRoute base)
Construct a builder initialized with state from specifiedExcludeRoute
.- Parameters:
base
- ExcludeRoute from which the builder should be initialized
-
-
Method Detail
-
getIpv4
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getIpv4()
Return current value associated with the property corresponding toExcludeRoute.getIpv4()
.- Returns:
- current value
-
getIpv6
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address getIpv6()
Return current value associated with the property corresponding toExcludeRoute.getIpv6()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExcludeRoute>> 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
-
setIpv4
public ExcludeRouteBuilder setIpv4(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)
Set the property corresponding toExcludeRoute.getIpv4()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIpv6
public ExcludeRouteBuilder setIpv6(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value)
Set the property corresponding toExcludeRoute.getIpv6()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ExcludeRouteBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ExcludeRoute> 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 ExcludeRouteBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExcludeRoute>> 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 ExcludeRoute build()
A newExcludeRoute
instance.- Returns:
- A new
ExcludeRoute
instance.
-
-