Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.evpn.destination
Class EvpnDestinationBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.evpn.destination.EvpnDestinationBuilder
-
@Generated("mdsal-binding-generator") public class EvpnDestinationBuilder extends Object
Class that buildsEvpnDestination
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:
EvpnDestination createEvpnDestination(int fooXyzzy, int barBaz) { return new EvpnDestinationBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of EvpnDestination, 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:
EvpnDestination
- 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 EvpnDestinationBuilder()
Construct an empty builder.EvpnDestinationBuilder(Evpn arg)
Construct a new builder initialized from specifiedEvpn
.EvpnDestinationBuilder(EvpnDestination base)
Construct a builder initialized with state from specifiedEvpnDestination
.EvpnDestinationBuilder(PathIdGrouping arg)
Construct a new builder initialized from specifiedPathIdGrouping
.EvpnDestinationBuilder(RouteDistinguisherGrouping arg)
Construct a new builder initialized from specifiedRouteDistinguisherGrouping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EvpnDestinationBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EvpnDestination> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EvpnDestination>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull EvpnDestination
build()
A newEvpnDestination
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.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()
.EvpnDestinationBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EvpnDestination>> augmentationType)
Remove an augmentation from this builder's product.EvpnDestinationBuilder
setEvpnChoice(EvpnChoice value)
Set the property corresponding toEvpn.getEvpnChoice()
to the specified value.EvpnDestinationBuilder
setPathId(PathId value)
Set the property corresponding toPathIdGrouping.getPathId()
to the specified value.EvpnDestinationBuilder
setRouteDistinguisher(RouteDistinguisher value)
Set the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
to the specified value.
-
-
-
Constructor Detail
-
EvpnDestinationBuilder
public EvpnDestinationBuilder()
Construct an empty builder.
-
EvpnDestinationBuilder
public EvpnDestinationBuilder(Evpn arg)
Construct a new builder initialized from specifiedEvpn
.- Parameters:
arg
- Evpn from which the builder should be initialized
-
EvpnDestinationBuilder
public EvpnDestinationBuilder(RouteDistinguisherGrouping arg)
Construct a new builder initialized from specifiedRouteDistinguisherGrouping
.- Parameters:
arg
- RouteDistinguisherGrouping from which the builder should be initialized
-
EvpnDestinationBuilder
public EvpnDestinationBuilder(PathIdGrouping arg)
Construct a new builder initialized from specifiedPathIdGrouping
.- Parameters:
arg
- PathIdGrouping from which the builder should be initialized
-
EvpnDestinationBuilder
public EvpnDestinationBuilder(EvpnDestination base)
Construct a builder initialized with state from specifiedEvpnDestination
.- Parameters:
base
- EvpnDestination 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
-
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
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EvpnDestination>> 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
-
setEvpnChoice
public EvpnDestinationBuilder setEvpnChoice(EvpnChoice value)
Set the property corresponding toEvpn.getEvpnChoice()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPathId
public EvpnDestinationBuilder setPathId(PathId value)
Set the property corresponding toPathIdGrouping.getPathId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRouteDistinguisher
public EvpnDestinationBuilder setRouteDistinguisher(RouteDistinguisher value)
Set the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public EvpnDestinationBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EvpnDestination> 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 EvpnDestinationBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EvpnDestination>> 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 EvpnDestination build()
A newEvpnDestination
instance.- Returns:
- A new
EvpnDestination
instance.
-
-