Class DestinationIpv6LabeledUnicastBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.labeled.unicast.rev180329.update.attributes.mp.unreach.nlri.withdrawn.routes.destination.type.destination.ipv6.labeled.unicast._case.DestinationIpv6LabeledUnicastBuilder
-
@Generated("mdsal-binding-generator") public class DestinationIpv6LabeledUnicastBuilder extends Object
Class that buildsDestinationIpv6LabeledUnicast
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:
DestinationIpv6LabeledUnicast createDestinationIpv6LabeledUnicast(int fooXyzzy, int barBaz) { return new DestinationIpv6LabeledUnicastBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DestinationIpv6LabeledUnicast, 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:
DestinationIpv6LabeledUnicast
- 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 DestinationIpv6LabeledUnicastBuilder()
Construct an empty builder.DestinationIpv6LabeledUnicastBuilder(LabeledUnicastDestination arg)
Construct a new builder initialized from specifiedLabeledUnicastDestination
.DestinationIpv6LabeledUnicastBuilder(DestinationIpv6LabeledUnicast base)
Construct a builder initialized with state from specifiedDestinationIpv6LabeledUnicast
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DestinationIpv6LabeledUnicastBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DestinationIpv6LabeledUnicast> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationIpv6LabeledUnicast>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull DestinationIpv6LabeledUnicast
build()
A newDestinationIpv6LabeledUnicast
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<CLabeledUnicastDestination>
getCLabeledUnicastDestination()
Return current value associated with the property corresponding toLabeledUnicastDestination.getCLabeledUnicastDestination()
.DestinationIpv6LabeledUnicastBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationIpv6LabeledUnicast>> augmentationType)
Remove an augmentation from this builder's product.DestinationIpv6LabeledUnicastBuilder
setCLabeledUnicastDestination(List<CLabeledUnicastDestination> values)
Set the property corresponding toLabeledUnicastDestination.getCLabeledUnicastDestination()
to the specified value.
-
-
-
Constructor Detail
-
DestinationIpv6LabeledUnicastBuilder
public DestinationIpv6LabeledUnicastBuilder()
Construct an empty builder.
-
DestinationIpv6LabeledUnicastBuilder
public DestinationIpv6LabeledUnicastBuilder(LabeledUnicastDestination arg)
Construct a new builder initialized from specifiedLabeledUnicastDestination
.- Parameters:
arg
- LabeledUnicastDestination from which the builder should be initialized
-
DestinationIpv6LabeledUnicastBuilder
public DestinationIpv6LabeledUnicastBuilder(DestinationIpv6LabeledUnicast base)
Construct a builder initialized with state from specifiedDestinationIpv6LabeledUnicast
.- Parameters:
base
- DestinationIpv6LabeledUnicast 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
-
getCLabeledUnicastDestination
public List<CLabeledUnicastDestination> getCLabeledUnicastDestination()
Return current value associated with the property corresponding toLabeledUnicastDestination.getCLabeledUnicastDestination()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationIpv6LabeledUnicast>> 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
-
setCLabeledUnicastDestination
public DestinationIpv6LabeledUnicastBuilder setCLabeledUnicastDestination(List<CLabeledUnicastDestination> values)
Set the property corresponding toLabeledUnicastDestination.getCLabeledUnicastDestination()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public DestinationIpv6LabeledUnicastBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DestinationIpv6LabeledUnicast> 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 DestinationIpv6LabeledUnicastBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationIpv6LabeledUnicast>> 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 DestinationIpv6LabeledUnicast build()
A newDestinationIpv6LabeledUnicast
instance.- Returns:
- A new
DestinationIpv6LabeledUnicast
instance.
-
-