Class AdvertizedRoutesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.reach.mp.reach.nlri.AdvertizedRoutesBuilder
-
@Generated("mdsal-binding-generator") public class AdvertizedRoutesBuilder extends Object
Class that buildsAdvertizedRoutes
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:
AdvertizedRoutes createAdvertizedRoutes(int fooXyzzy, int barBaz) { return new AdvertizedRoutesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AdvertizedRoutes, 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:
AdvertizedRoutes
- 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 AdvertizedRoutesBuilder()
Construct an empty builder.AdvertizedRoutesBuilder(AdvertizedRoutes base)
Construct a builder initialized with state from specifiedAdvertizedRoutes
.AdvertizedRoutesBuilder(Destination arg)
Construct a new builder initialized from specifiedDestination
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AdvertizedRoutesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AdvertizedRoutes> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AdvertizedRoutes>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull AdvertizedRoutes
build()
A newAdvertizedRoutes
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.DestinationType
getDestinationType()
Return current value associated with the property corresponding toDestination.getDestinationType()
.AdvertizedRoutesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AdvertizedRoutes>> augmentationType)
Remove an augmentation from this builder's product.AdvertizedRoutesBuilder
setDestinationType(DestinationType value)
Set the property corresponding toDestination.getDestinationType()
to the specified value.
-
-
-
Constructor Detail
-
AdvertizedRoutesBuilder
public AdvertizedRoutesBuilder()
Construct an empty builder.
-
AdvertizedRoutesBuilder
public AdvertizedRoutesBuilder(Destination arg)
Construct a new builder initialized from specifiedDestination
.- Parameters:
arg
- Destination from which the builder should be initialized
-
AdvertizedRoutesBuilder
public AdvertizedRoutesBuilder(AdvertizedRoutes base)
Construct a builder initialized with state from specifiedAdvertizedRoutes
.- Parameters:
base
- AdvertizedRoutes 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
-
getDestinationType
public DestinationType getDestinationType()
Return current value associated with the property corresponding toDestination.getDestinationType()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AdvertizedRoutes>> 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
-
setDestinationType
public AdvertizedRoutesBuilder setDestinationType(DestinationType value)
Set the property corresponding toDestination.getDestinationType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public AdvertizedRoutesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AdvertizedRoutes> 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 AdvertizedRoutesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AdvertizedRoutes>> 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 AdvertizedRoutes build()
A newAdvertizedRoutes
instance.- Returns:
- A new
AdvertizedRoutes
instance.
-
-