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