Class EthernetADRouteBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.ethernet.a.d.route.EthernetADRouteBuilder
-
@Generated("mdsal-binding-generator") public class EthernetADRouteBuilder extends Object
Class that buildsEthernetADRoute
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:
EthernetADRoute createEthernetADRoute(int fooXyzzy, int barBaz) { return new EthernetADRouteBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of EthernetADRoute, 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:
EthernetADRoute
- 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 EthernetADRouteBuilder()
Construct an empty builder.EthernetADRouteBuilder(Esi arg)
Construct a new builder initialized from specifiedEsi
.EthernetADRouteBuilder(EthernetADRoute base)
Construct a builder initialized with state from specifiedEthernetADRoute
.EthernetADRouteBuilder(EthernetTagId arg)
Construct a new builder initialized from specifiedEthernetTagId
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EthernetADRouteBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EthernetADRoute> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EthernetADRoute>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull EthernetADRoute
build()
A newEthernetADRoute
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Esi
getEsi()
Return current value associated with the property corresponding toEsi.getEsi()
.EthernetTagId
getEthernetTagId()
Return current value associated with the property corresponding toEthernetTagId.getEthernetTagId()
.MplsLabel
getMplsLabel()
Return current value associated with the property corresponding toEthernetADRoute.getMplsLabel()
.EthernetADRouteBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EthernetADRoute>> augmentationType)
Remove an augmentation from this builder's product.EthernetADRouteBuilder
setEsi(Esi value)
Set the property corresponding toEsi.getEsi()
to the specified value.EthernetADRouteBuilder
setEthernetTagId(EthernetTagId value)
Set the property corresponding toEthernetTagId.getEthernetTagId()
to the specified value.EthernetADRouteBuilder
setMplsLabel(MplsLabel value)
Set the property corresponding toEthernetADRoute.getMplsLabel()
to the specified value.
-
-
-
Constructor Detail
-
EthernetADRouteBuilder
public EthernetADRouteBuilder()
Construct an empty builder.
-
EthernetADRouteBuilder
public EthernetADRouteBuilder(Esi arg)
Construct a new builder initialized from specifiedEsi
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.Esi from which the builder should be initialized
-
EthernetADRouteBuilder
public EthernetADRouteBuilder(EthernetTagId arg)
Construct a new builder initialized from specifiedEthernetTagId
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.EthernetTagId from which the builder should be initialized
-
EthernetADRouteBuilder
public EthernetADRouteBuilder(EthernetADRoute base)
Construct a builder initialized with state from specifiedEthernetADRoute
.- Parameters:
base
- EthernetADRoute 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
-
getEsi
public Esi getEsi()
Return current value associated with the property corresponding toEsi.getEsi()
.- Returns:
- current value
-
getEthernetTagId
public EthernetTagId getEthernetTagId()
Return current value associated with the property corresponding toEthernetTagId.getEthernetTagId()
.- Returns:
- current value
-
getMplsLabel
public MplsLabel getMplsLabel()
Return current value associated with the property corresponding toEthernetADRoute.getMplsLabel()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EthernetADRoute>> 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
-
setEsi
public EthernetADRouteBuilder setEsi(Esi value)
Set the property corresponding toEsi.getEsi()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEthernetTagId
public EthernetADRouteBuilder setEthernetTagId(EthernetTagId value)
Set the property corresponding toEthernetTagId.getEthernetTagId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMplsLabel
public EthernetADRouteBuilder setMplsLabel(MplsLabel value)
Set the property corresponding toEthernetADRoute.getMplsLabel()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public EthernetADRouteBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EthernetADRoute> 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 EthernetADRouteBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EthernetADRoute>> 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 EthernetADRoute build()
A newEthernetADRoute
instance.- Returns:
- A new
EthernetADRoute
instance.
-
-