Class EvpnRouteBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.evpn.routes.evpn.routes.EvpnRouteBuilder
-
@Generated("mdsal-binding-generator") public class EvpnRouteBuilder extends Object
Class that buildsEvpnRoute
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:
EvpnRoute createEvpnRoute(int fooXyzzy, int barBaz) { return new EvpnRouteBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of EvpnRoute, 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:
EvpnRoute
- 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 EvpnRouteBuilder()
Construct an empty builder.EvpnRouteBuilder(Evpn arg)
Construct a new builder initialized from specifiedEvpn
.EvpnRouteBuilder(EvpnRoute base)
Construct a builder initialized with state from specifiedEvpnRoute
.EvpnRouteBuilder(PathAttributes arg)
Construct a new builder initialized from specifiedPathAttributes
.EvpnRouteBuilder(PathIdGrouping arg)
Construct a new builder initialized from specifiedPathIdGrouping
.EvpnRouteBuilder(Route arg)
Construct a new builder initialized from specifiedRoute
.EvpnRouteBuilder(RouteDistinguisherGrouping arg)
Construct a new builder initialized from specifiedRouteDistinguisherGrouping
.EvpnRouteBuilder(BgpRibRoute arg)
Construct a new builder initialized from specifiedBgpRibRoute
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EvpnRouteBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EvpnRoute> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EvpnRoute>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull EvpnRoute
build()
A newEvpnRoute
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()
.EvpnChoice
getEvpnChoice()
Return current value associated with the property corresponding toEvpn.getEvpnChoice()
.PathId
getPathId()
Return current value associated with the property corresponding toPathIdGrouping.getPathId()
.RouteDistinguisher
getRouteDistinguisher()
Return current value associated with the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
.String
getRouteKey()
Return current value associated with the property corresponding toRoute.getRouteKey()
.EvpnRouteKey
key()
Return current value associated with the property corresponding toEvpnRoute.key()
.EvpnRouteBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EvpnRoute>> augmentationType)
Remove an augmentation from this builder's product.EvpnRouteBuilder
setAttributes(Attributes value)
Set the property corresponding toPathAttributes.getAttributes()
to the specified value.EvpnRouteBuilder
setEvpnChoice(EvpnChoice value)
Set the property corresponding toEvpn.getEvpnChoice()
to the specified value.EvpnRouteBuilder
setPathId(PathId value)
Set the property corresponding toPathIdGrouping.getPathId()
to the specified value.EvpnRouteBuilder
setRouteDistinguisher(RouteDistinguisher value)
Set the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
to the specified value.EvpnRouteBuilder
setRouteKey(String value)
Set the property corresponding toRoute.getRouteKey()
to the specified value.EvpnRouteBuilder
withKey(EvpnRouteKey key)
-
-
-
Constructor Detail
-
EvpnRouteBuilder
public EvpnRouteBuilder()
Construct an empty builder.
-
EvpnRouteBuilder
public EvpnRouteBuilder(Evpn arg)
Construct a new builder initialized from specifiedEvpn
.- Parameters:
arg
- Evpn from which the builder should be initialized
-
EvpnRouteBuilder
public EvpnRouteBuilder(RouteDistinguisherGrouping arg)
Construct a new builder initialized from specifiedRouteDistinguisherGrouping
.- Parameters:
arg
- RouteDistinguisherGrouping from which the builder should be initialized
-
EvpnRouteBuilder
public EvpnRouteBuilder(BgpRibRoute arg)
Construct a new builder initialized from specifiedBgpRibRoute
.- Parameters:
arg
- BgpRibRoute from which the builder should be initialized
-
EvpnRouteBuilder
public EvpnRouteBuilder(Route arg)
Construct a new builder initialized from specifiedRoute
.- Parameters:
arg
- Route from which the builder should be initialized
-
EvpnRouteBuilder
public EvpnRouteBuilder(PathIdGrouping arg)
Construct a new builder initialized from specifiedPathIdGrouping
.- Parameters:
arg
- PathIdGrouping from which the builder should be initialized
-
EvpnRouteBuilder
public EvpnRouteBuilder(PathAttributes arg)
Construct a new builder initialized from specifiedPathAttributes
.- Parameters:
arg
- PathAttributes 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 EvpnRouteKey key()
Return current value associated with the property corresponding toEvpnRoute.key()
.- Returns:
- current value
-
getAttributes
public Attributes getAttributes()
Return current value associated with the property corresponding toPathAttributes.getAttributes()
.- Returns:
- current value
-
getEvpnChoice
public EvpnChoice getEvpnChoice()
Return current value associated with the property corresponding toEvpn.getEvpnChoice()
.- Returns:
- current value
-
getPathId
public PathId getPathId()
Return current value associated with the property corresponding toPathIdGrouping.getPathId()
.- 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<EvpnRoute>> 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 EvpnRouteBuilder withKey(EvpnRouteKey key)
-
setAttributes
public EvpnRouteBuilder setAttributes(Attributes value)
Set the property corresponding toPathAttributes.getAttributes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEvpnChoice
public EvpnRouteBuilder setEvpnChoice(EvpnChoice value)
Set the property corresponding toEvpn.getEvpnChoice()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPathId
public EvpnRouteBuilder setPathId(PathId value)
Set the property corresponding toPathIdGrouping.getPathId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRouteDistinguisher
public EvpnRouteBuilder setRouteDistinguisher(RouteDistinguisher value)
Set the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRouteKey
public EvpnRouteBuilder setRouteKey(String value)
Set the property corresponding toRoute.getRouteKey()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public EvpnRouteBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EvpnRoute> 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 EvpnRouteBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EvpnRoute>> 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
-
-