Class RejectRouteBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.generic.actions.route.disposition.RejectRouteBuilder
-
@Generated("mdsal-binding-generator") public class RejectRouteBuilder extends Object
Class that buildsRejectRoute
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:
RejectRoute createRejectRoute(int fooXyzzy, int barBaz) { return new RejectRouteBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RejectRoute, 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:
RejectRoute
- 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 RejectRouteBuilder()
Construct an empty builder.RejectRouteBuilder(RejectRoute base)
Construct a builder initialized with state from specifiedRejectRoute
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RejectRouteBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RejectRoute> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RejectRoute>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull RejectRoute
build()
A newRejectRoute
instance.org.opendaylight.yangtools.yang.common.Empty
getRejectRoute()
Return current value associated with the property corresponding toRejectRoute.getRejectRoute()
.RejectRouteBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RejectRoute>> augmentationType)
Remove an augmentation from this builder's product.RejectRouteBuilder
setRejectRoute(org.opendaylight.yangtools.yang.common.Empty value)
Set the property corresponding toRejectRoute.getRejectRoute()
to the specified value.
-
-
-
Constructor Detail
-
RejectRouteBuilder
public RejectRouteBuilder()
Construct an empty builder.
-
RejectRouteBuilder
public RejectRouteBuilder(RejectRoute base)
Construct a builder initialized with state from specifiedRejectRoute
.- Parameters:
base
- RejectRoute from which the builder should be initialized
-
-
Method Detail
-
getRejectRoute
public org.opendaylight.yangtools.yang.common.Empty getRejectRoute()
Return current value associated with the property corresponding toRejectRoute.getRejectRoute()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RejectRoute>> 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
-
setRejectRoute
public RejectRouteBuilder setRejectRoute(org.opendaylight.yangtools.yang.common.Empty value)
Set the property corresponding toRejectRoute.getRejectRoute()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public RejectRouteBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RejectRoute> 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 RejectRouteBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RejectRoute>> 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 RejectRoute build()
A newRejectRoute
instance.- Returns:
- A new
RejectRoute
instance.
-
-