Class Ipv6CaseBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.endpoints.address.family.Ipv6CaseBuilder
Class that builds
Ipv6Case
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:
Ipv6Case createIpv6Case(int fooXyzzy, int barBaz) {
return new Ipv6CaseBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Ipv6Case, 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.Ipv6CaseBuilder
(Ipv6Case base) Construct a builder initialized with state from specifiedIpv6Case
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<Ipv6Case> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<Ipv6Case>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Ipv6Case
build()
A newIpv6Case
instance.getIpv6()
Return current value associated with the property corresponding toIpv6Case.getIpv6()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<Ipv6Case>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toIpv6Case.getIpv6()
to the specified value.
-
Constructor Details
-
Ipv6CaseBuilder
public Ipv6CaseBuilder()Construct an empty builder. -
Ipv6CaseBuilder
Construct a builder initialized with state from specifiedIpv6Case
.- Parameters:
base
- Ipv6Case from which the builder should be initialized
-
-
Method Details
-
getIpv6
Return current value associated with the property corresponding toIpv6Case.getIpv6()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<Ipv6Case>> 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
-
setIpv6
Set the property corresponding toIpv6Case.getIpv6()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Ipv6CaseBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<Ipv6Case> 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 Ipv6CaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<Ipv6Case>> 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 newIpv6Case
instance.- Returns:
- A new
Ipv6Case
instance.
-