Class LinkstateRouteBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.routes.linkstate.routes.LinkstateRouteBuilder
-
@Generated("mdsal-binding-generator") public class LinkstateRouteBuilder extends Object
Class that buildsLinkstateRoute
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:
LinkstateRoute createLinkstateRoute(int fooXyzzy, int barBaz) { return new LinkstateRouteBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LinkstateRoute, 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:
LinkstateRoute
- 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 LinkstateRouteBuilder()
Construct an empty builder.LinkstateRouteBuilder(Linkstate arg)
Construct a new builder initialized from specifiedLinkstate
.LinkstateRouteBuilder(LinkstateRoute base)
Construct a builder initialized with state from specifiedLinkstateRoute
.LinkstateRouteBuilder(PathAttributes arg)
Construct a new builder initialized from specifiedPathAttributes
.LinkstateRouteBuilder(PathIdGrouping arg)
Construct a new builder initialized from specifiedPathIdGrouping
.LinkstateRouteBuilder(Route arg)
Construct a new builder initialized from specifiedRoute
.LinkstateRouteBuilder(RouteDistinguisherGrouping arg)
Construct a new builder initialized from specifiedRouteDistinguisherGrouping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LinkstateRouteBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LinkstateRoute> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LinkstateRoute>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull LinkstateRoute
build()
A newLinkstateRoute
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()
.Identifier
getIdentifier()
Return current value associated with the property corresponding toLinkstate.getIdentifier()
.ObjectType
getObjectType()
Return current value associated with the property corresponding toLinkstate.getObjectType()
.PathId
getPathId()
Return current value associated with the property corresponding toPathIdGrouping.getPathId()
.ProtocolId
getProtocolId()
Return current value associated with the property corresponding toLinkstate.getProtocolId()
.RouteDistinguisher
getRouteDistinguisher()
Return current value associated with the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
.String
getRouteKey()
Return current value associated with the property corresponding toRoute.getRouteKey()
.LinkstateRouteKey
key()
Return current value associated with the property corresponding toLinkstateRoute.key()
.LinkstateRouteBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LinkstateRoute>> augmentationType)
Remove an augmentation from this builder's product.LinkstateRouteBuilder
setAttributes(Attributes value)
Set the property corresponding toPathAttributes.getAttributes()
to the specified value.LinkstateRouteBuilder
setIdentifier(Identifier value)
Set the property corresponding toLinkstate.getIdentifier()
to the specified value.LinkstateRouteBuilder
setObjectType(ObjectType value)
Set the property corresponding toLinkstate.getObjectType()
to the specified value.LinkstateRouteBuilder
setPathId(PathId value)
Set the property corresponding toPathIdGrouping.getPathId()
to the specified value.LinkstateRouteBuilder
setProtocolId(ProtocolId value)
Set the property corresponding toLinkstate.getProtocolId()
to the specified value.LinkstateRouteBuilder
setRouteDistinguisher(RouteDistinguisher value)
Set the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
to the specified value.LinkstateRouteBuilder
setRouteKey(String value)
Set the property corresponding toRoute.getRouteKey()
to the specified value.LinkstateRouteBuilder
withKey(LinkstateRouteKey key)
-
-
-
Constructor Detail
-
LinkstateRouteBuilder
public LinkstateRouteBuilder()
Construct an empty builder.
-
LinkstateRouteBuilder
public LinkstateRouteBuilder(Linkstate arg)
Construct a new builder initialized from specifiedLinkstate
.- Parameters:
arg
- Linkstate from which the builder should be initialized
-
LinkstateRouteBuilder
public LinkstateRouteBuilder(RouteDistinguisherGrouping arg)
Construct a new builder initialized from specifiedRouteDistinguisherGrouping
.- Parameters:
arg
- RouteDistinguisherGrouping from which the builder should be initialized
-
LinkstateRouteBuilder
public LinkstateRouteBuilder(Route arg)
Construct a new builder initialized from specifiedRoute
.- Parameters:
arg
- Route from which the builder should be initialized
-
LinkstateRouteBuilder
public LinkstateRouteBuilder(PathIdGrouping arg)
Construct a new builder initialized from specifiedPathIdGrouping
.- Parameters:
arg
- PathIdGrouping from which the builder should be initialized
-
LinkstateRouteBuilder
public LinkstateRouteBuilder(PathAttributes arg)
Construct a new builder initialized from specifiedPathAttributes
.- Parameters:
arg
- PathAttributes from which the builder should be initialized
-
LinkstateRouteBuilder
public LinkstateRouteBuilder(LinkstateRoute base)
Construct a builder initialized with state from specifiedLinkstateRoute
.- Parameters:
base
- LinkstateRoute 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 LinkstateRouteKey key()
Return current value associated with the property corresponding toLinkstateRoute.key()
.- Returns:
- current value
-
getAttributes
public Attributes getAttributes()
Return current value associated with the property corresponding toPathAttributes.getAttributes()
.- Returns:
- current value
-
getIdentifier
public Identifier getIdentifier()
Return current value associated with the property corresponding toLinkstate.getIdentifier()
.- Returns:
- current value
-
getObjectType
public ObjectType getObjectType()
Return current value associated with the property corresponding toLinkstate.getObjectType()
.- Returns:
- current value
-
getPathId
public PathId getPathId()
Return current value associated with the property corresponding toPathIdGrouping.getPathId()
.- Returns:
- current value
-
getProtocolId
public ProtocolId getProtocolId()
Return current value associated with the property corresponding toLinkstate.getProtocolId()
.- Returns:
- current value
-
getRouteDistinguisher
public RouteDistinguisher getRouteDistinguisher()
Return current value associated with the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
.- 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<LinkstateRoute>> 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 LinkstateRouteBuilder withKey(LinkstateRouteKey key)
-
setAttributes
public LinkstateRouteBuilder setAttributes(Attributes value)
Set the property corresponding toPathAttributes.getAttributes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIdentifier
public LinkstateRouteBuilder setIdentifier(Identifier value)
Set the property corresponding toLinkstate.getIdentifier()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setObjectType
public LinkstateRouteBuilder setObjectType(ObjectType value)
Set the property corresponding toLinkstate.getObjectType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPathId
public LinkstateRouteBuilder setPathId(PathId value)
Set the property corresponding toPathIdGrouping.getPathId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setProtocolId
public LinkstateRouteBuilder setProtocolId(ProtocolId value)
Set the property corresponding toLinkstate.getProtocolId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRouteDistinguisher
public LinkstateRouteBuilder setRouteDistinguisher(RouteDistinguisher value)
Set the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRouteKey
public LinkstateRouteBuilder setRouteKey(String value)
Set the property corresponding toRoute.getRouteKey()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public LinkstateRouteBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LinkstateRoute> 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 LinkstateRouteBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LinkstateRoute>> 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 LinkstateRoute build()
A newLinkstateRoute
instance.- Returns:
- A new
LinkstateRoute
instance.
-
-