Class DestinationIpv6LabeledUnicastCaseBuilder
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.DestinationIpv6LabeledUnicastCaseBuilder
@Generated("mdsal-binding-generator")
public class DestinationIpv6LabeledUnicastCaseBuilder
extends Object
Class that builds
DestinationIpv6LabeledUnicastCase
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:
DestinationIpv6LabeledUnicastCase createDestinationIpv6LabeledUnicastCase(int fooXyzzy, int barBaz) {
return new DestinationIpv6LabeledUnicastCaseBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of DestinationIpv6LabeledUnicastCase, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedDestinationIpv6LabeledUnicastCase
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<DestinationIpv6LabeledUnicastCase> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationIpv6LabeledUnicastCase>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull DestinationIpv6LabeledUnicastCase
build()
A newDestinationIpv6LabeledUnicastCase
instance.Return current value associated with the property corresponding toDestinationIpv6LabeledUnicastCase.getDestinationIpv6LabeledUnicast()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationIpv6LabeledUnicastCase>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toDestinationIpv6LabeledUnicastCase.getDestinationIpv6LabeledUnicast()
to the specified value.
-
Constructor Details
-
DestinationIpv6LabeledUnicastCaseBuilder
public DestinationIpv6LabeledUnicastCaseBuilder()Construct an empty builder. -
DestinationIpv6LabeledUnicastCaseBuilder
Construct a builder initialized with state from specifiedDestinationIpv6LabeledUnicastCase
.- Parameters:
base
- DestinationIpv6LabeledUnicastCase from which the builder should be initialized
-
-
Method Details
-
getDestinationIpv6LabeledUnicast
Return current value associated with the property corresponding toDestinationIpv6LabeledUnicastCase.getDestinationIpv6LabeledUnicast()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationIpv6LabeledUnicastCase>> 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
-
setDestinationIpv6LabeledUnicast
public DestinationIpv6LabeledUnicastCaseBuilder setDestinationIpv6LabeledUnicast(DestinationIpv6LabeledUnicast value) Set the property corresponding toDestinationIpv6LabeledUnicastCase.getDestinationIpv6LabeledUnicast()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public DestinationIpv6LabeledUnicastCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DestinationIpv6LabeledUnicastCase> 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 DestinationIpv6LabeledUnicastCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationIpv6LabeledUnicastCase>> 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
A newDestinationIpv6LabeledUnicastCase
instance.- Returns:
- A new
DestinationIpv6LabeledUnicastCase
instance.
-