Class RouteTargetConstrainRouteBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.route.target.constrain.rev180618.route.target.constrain.routes.route.target.constrain.routes.RouteTargetConstrainRouteBuilder
-
@Generated("mdsal-binding-generator") public class RouteTargetConstrainRouteBuilder extends Object
Class that buildsRouteTargetConstrainRoute
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:
RouteTargetConstrainRoute createRouteTargetConstrainRoute(int fooXyzzy, int barBaz) { return new RouteTargetConstrainRouteBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RouteTargetConstrainRoute, 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:
RouteTargetConstrainRoute
- 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 RouteTargetConstrainRouteBuilder()
Construct an empty builder.RouteTargetConstrainRouteBuilder(PathAttributes arg)
Construct a new builder initialized from specifiedPathAttributes
.RouteTargetConstrainRouteBuilder(PathIdGrouping arg)
Construct a new builder initialized from specifiedPathIdGrouping
.RouteTargetConstrainRouteBuilder(Route arg)
Construct a new builder initialized from specifiedRoute
.RouteTargetConstrainRouteBuilder(RouteTargetConstrainRoute base)
Construct a builder initialized with state from specifiedRouteTargetConstrainRoute
.RouteTargetConstrainRouteBuilder(RouteTargetConstrain arg)
Construct a new builder initialized from specifiedRouteTargetConstrain
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RouteTargetConstrainRouteBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RouteTargetConstrainRoute> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteTargetConstrainRoute>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull RouteTargetConstrainRoute
build()
A newRouteTargetConstrainRoute
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Attributes
getAttributes()
Return current value associated with the property corresponding toPathAttributes.getAttributes()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber
getOriginAs()
Return current value associated with the property corresponding toRouteTargetConstrain.getOriginAs()
.PathId
getPathId()
Return current value associated with the property corresponding toPathIdGrouping.getPathId()
.String
getRouteKey()
Return current value associated with the property corresponding toRoute.getRouteKey()
.RouteTargetConstrainChoice
getRouteTargetConstrainChoice()
Return current value associated with the property corresponding toRouteTargetConstrain.getRouteTargetConstrainChoice()
.RouteTargetConstrainRouteKey
key()
Return current value associated with the property corresponding toRouteTargetConstrainRoute.key()
.RouteTargetConstrainRouteBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteTargetConstrainRoute>> augmentationType)
Remove an augmentation from this builder's product.RouteTargetConstrainRouteBuilder
setAttributes(Attributes value)
Set the property corresponding toPathAttributes.getAttributes()
to the specified value.RouteTargetConstrainRouteBuilder
setOriginAs(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
Set the property corresponding toRouteTargetConstrain.getOriginAs()
to the specified value.RouteTargetConstrainRouteBuilder
setPathId(PathId value)
Set the property corresponding toPathIdGrouping.getPathId()
to the specified value.RouteTargetConstrainRouteBuilder
setRouteKey(String value)
Set the property corresponding toRoute.getRouteKey()
to the specified value.RouteTargetConstrainRouteBuilder
setRouteTargetConstrainChoice(RouteTargetConstrainChoice value)
Set the property corresponding toRouteTargetConstrain.getRouteTargetConstrainChoice()
to the specified value.RouteTargetConstrainRouteBuilder
withKey(RouteTargetConstrainRouteKey key)
-
-
-
Constructor Detail
-
RouteTargetConstrainRouteBuilder
public RouteTargetConstrainRouteBuilder()
Construct an empty builder.
-
RouteTargetConstrainRouteBuilder
public RouteTargetConstrainRouteBuilder(Route arg)
Construct a new builder initialized from specifiedRoute
.- Parameters:
arg
- Route from which the builder should be initialized
-
RouteTargetConstrainRouteBuilder
public RouteTargetConstrainRouteBuilder(PathIdGrouping arg)
Construct a new builder initialized from specifiedPathIdGrouping
.- Parameters:
arg
- PathIdGrouping from which the builder should be initialized
-
RouteTargetConstrainRouteBuilder
public RouteTargetConstrainRouteBuilder(PathAttributes arg)
Construct a new builder initialized from specifiedPathAttributes
.- Parameters:
arg
- PathAttributes from which the builder should be initialized
-
RouteTargetConstrainRouteBuilder
public RouteTargetConstrainRouteBuilder(RouteTargetConstrain arg)
Construct a new builder initialized from specifiedRouteTargetConstrain
.- Parameters:
arg
- RouteTargetConstrain from which the builder should be initialized
-
RouteTargetConstrainRouteBuilder
public RouteTargetConstrainRouteBuilder(RouteTargetConstrainRoute base)
Construct a builder initialized with state from specifiedRouteTargetConstrainRoute
.- Parameters:
base
- RouteTargetConstrainRoute 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
-
key
public RouteTargetConstrainRouteKey key()
Return current value associated with the property corresponding toRouteTargetConstrainRoute.key()
.- Returns:
- current value
-
getAttributes
public Attributes getAttributes()
Return current value associated with the property corresponding toPathAttributes.getAttributes()
.- Returns:
- current value
-
getOriginAs
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getOriginAs()
Return current value associated with the property corresponding toRouteTargetConstrain.getOriginAs()
.- Returns:
- current value
-
getPathId
public PathId getPathId()
Return current value associated with the property corresponding toPathIdGrouping.getPathId()
.- Returns:
- current value
-
getRouteKey
public String getRouteKey()
Return current value associated with the property corresponding toRoute.getRouteKey()
.- Returns:
- current value
-
getRouteTargetConstrainChoice
public RouteTargetConstrainChoice getRouteTargetConstrainChoice()
Return current value associated with the property corresponding toRouteTargetConstrain.getRouteTargetConstrainChoice()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteTargetConstrainRoute>> 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
-
withKey
public RouteTargetConstrainRouteBuilder withKey(RouteTargetConstrainRouteKey key)
-
setAttributes
public RouteTargetConstrainRouteBuilder setAttributes(Attributes value)
Set the property corresponding toPathAttributes.getAttributes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOriginAs
public RouteTargetConstrainRouteBuilder setOriginAs(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
Set the property corresponding toRouteTargetConstrain.getOriginAs()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPathId
public RouteTargetConstrainRouteBuilder setPathId(PathId value)
Set the property corresponding toPathIdGrouping.getPathId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRouteKey
public RouteTargetConstrainRouteBuilder setRouteKey(String value)
Set the property corresponding toRoute.getRouteKey()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRouteTargetConstrainChoice
public RouteTargetConstrainRouteBuilder setRouteTargetConstrainChoice(RouteTargetConstrainChoice value)
Set the property corresponding toRouteTargetConstrain.getRouteTargetConstrainChoice()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public RouteTargetConstrainRouteBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RouteTargetConstrainRoute> 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 RouteTargetConstrainRouteBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RouteTargetConstrainRoute>> 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 RouteTargetConstrainRoute build()
A newRouteTargetConstrainRoute
instance.- Returns:
- A new
RouteTargetConstrainRoute
instance.
-
-