Class LabeledUnicastRouteBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.labeled.unicast.rev180329.labeled.unicast.routes.list.LabeledUnicastRouteBuilder
-
@Generated("mdsal-binding-generator") public class LabeledUnicastRouteBuilder extends Object
Class that buildsLabeledUnicastRoute
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:
LabeledUnicastRoute createLabeledUnicastRoute(int fooXyzzy, int barBaz) { return new LabeledUnicastRouteBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LabeledUnicastRoute, 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:
LabeledUnicastRoute
- 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 LabeledUnicastRouteBuilder()
Construct an empty builder.LabeledUnicastRouteBuilder(LabeledUnicastRoute base)
Construct a builder initialized with state from specifiedLabeledUnicastRoute
.LabeledUnicastRouteBuilder(LabeledUnicast arg)
Construct a new builder initialized from specifiedLabeledUnicast
.LabeledUnicastRouteBuilder(PathAttributes arg)
Construct a new builder initialized from specifiedPathAttributes
.LabeledUnicastRouteBuilder(PathIdGrouping arg)
Construct a new builder initialized from specifiedPathIdGrouping
.LabeledUnicastRouteBuilder(Route arg)
Construct a new builder initialized from specifiedRoute
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LabeledUnicastRouteBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LabeledUnicastRoute> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LabeledUnicastRoute>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull LabeledUnicastRoute
build()
A newLabeledUnicastRoute
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()
.List<LabelStack>
getLabelStack()
Return current value associated with the property corresponding toLabeledUnicast.getLabelStack()
.PathId
getPathId()
Return current value associated with the property corresponding toPathIdGrouping.getPathId()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix
getPrefix()
Return current value associated with the property corresponding toLabeledUnicast.getPrefix()
.String
getRouteKey()
Return current value associated with the property corresponding toRoute.getRouteKey()
.LabeledUnicastRouteKey
key()
Return current value associated with the property corresponding toLabeledUnicastRoute.key()
.LabeledUnicastRouteBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LabeledUnicastRoute>> augmentationType)
Remove an augmentation from this builder's product.LabeledUnicastRouteBuilder
setAttributes(Attributes value)
Set the property corresponding toPathAttributes.getAttributes()
to the specified value.LabeledUnicastRouteBuilder
setLabelStack(List<LabelStack> values)
Set the property corresponding toLabeledUnicast.getLabelStack()
to the specified value.LabeledUnicastRouteBuilder
setPathId(PathId value)
Set the property corresponding toPathIdGrouping.getPathId()
to the specified value.LabeledUnicastRouteBuilder
setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
Set the property corresponding toLabeledUnicast.getPrefix()
to the specified value.LabeledUnicastRouteBuilder
setRouteKey(String value)
Set the property corresponding toRoute.getRouteKey()
to the specified value.LabeledUnicastRouteBuilder
withKey(LabeledUnicastRouteKey key)
-
-
-
Constructor Detail
-
LabeledUnicastRouteBuilder
public LabeledUnicastRouteBuilder()
Construct an empty builder.
-
LabeledUnicastRouteBuilder
public LabeledUnicastRouteBuilder(LabeledUnicast arg)
Construct a new builder initialized from specifiedLabeledUnicast
.- Parameters:
arg
- LabeledUnicast from which the builder should be initialized
-
LabeledUnicastRouteBuilder
public LabeledUnicastRouteBuilder(Route arg)
Construct a new builder initialized from specifiedRoute
.- Parameters:
arg
- Route from which the builder should be initialized
-
LabeledUnicastRouteBuilder
public LabeledUnicastRouteBuilder(PathIdGrouping arg)
Construct a new builder initialized from specifiedPathIdGrouping
.- Parameters:
arg
- PathIdGrouping from which the builder should be initialized
-
LabeledUnicastRouteBuilder
public LabeledUnicastRouteBuilder(PathAttributes arg)
Construct a new builder initialized from specifiedPathAttributes
.- Parameters:
arg
- PathAttributes from which the builder should be initialized
-
LabeledUnicastRouteBuilder
public LabeledUnicastRouteBuilder(LabeledUnicastRoute base)
Construct a builder initialized with state from specifiedLabeledUnicastRoute
.- Parameters:
base
- LabeledUnicastRoute 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 LabeledUnicastRouteKey key()
Return current value associated with the property corresponding toLabeledUnicastRoute.key()
.- Returns:
- current value
-
getAttributes
public Attributes getAttributes()
Return current value associated with the property corresponding toPathAttributes.getAttributes()
.- Returns:
- current value
-
getLabelStack
public List<LabelStack> getLabelStack()
Return current value associated with the property corresponding toLabeledUnicast.getLabelStack()
.- Returns:
- current value
-
getPathId
public PathId getPathId()
Return current value associated with the property corresponding toPathIdGrouping.getPathId()
.- Returns:
- current value
-
getPrefix
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getPrefix()
Return current value associated with the property corresponding toLabeledUnicast.getPrefix()
.- Returns:
- current value
-
getRouteKey
public String getRouteKey()
Return current value associated with the property corresponding toRoute.getRouteKey()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LabeledUnicastRoute>> 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 LabeledUnicastRouteBuilder withKey(LabeledUnicastRouteKey key)
-
setAttributes
public LabeledUnicastRouteBuilder setAttributes(Attributes value)
Set the property corresponding toPathAttributes.getAttributes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLabelStack
public LabeledUnicastRouteBuilder setLabelStack(List<LabelStack> values)
Set the property corresponding toLabeledUnicast.getLabelStack()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setPathId
public LabeledUnicastRouteBuilder setPathId(PathId value)
Set the property corresponding toPathIdGrouping.getPathId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPrefix
public LabeledUnicastRouteBuilder setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
Set the property corresponding toLabeledUnicast.getPrefix()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRouteKey
public LabeledUnicastRouteBuilder setRouteKey(String value)
Set the property corresponding toRoute.getRouteKey()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public LabeledUnicastRouteBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LabeledUnicastRoute> 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 LabeledUnicastRouteBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LabeledUnicastRoute>> 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 LabeledUnicastRoute build()
A newLabeledUnicastRoute
instance.- Returns:
- A new
LabeledUnicastRoute
instance.
-
-