Class Ipv6EroBackupCaseBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev200120.binding.sub.tlvs.binding.sub.tlv.Ipv6EroBackupCaseBuilder
Class that builds
Ipv6EroBackupCase
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:
Ipv6EroBackupCase createIpv6EroBackupCase(int fooXyzzy, int barBaz) {
return new Ipv6EroBackupCaseBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Ipv6EroBackupCase, 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 specifiedIpv6EroBackupCase
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6EroBackupCase> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6EroBackupCase>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Ipv6EroBackupCase
build()
A newIpv6EroBackupCase
instance.Return current value associated with the property corresponding toIpv6EroBackupCase.getIpv6EroBackup()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6EroBackupCase>> augmentationType) Remove an augmentation from this builder's product.setIpv6EroBackup
(Ipv6EroBackup value) Set the property corresponding toIpv6EroBackupCase.getIpv6EroBackup()
to the specified value.
-
Constructor Details
-
Ipv6EroBackupCaseBuilder
public Ipv6EroBackupCaseBuilder()Construct an empty builder. -
Ipv6EroBackupCaseBuilder
Construct a builder initialized with state from specifiedIpv6EroBackupCase
.- Parameters:
base
- Ipv6EroBackupCase from which the builder should be initialized
-
-
Method Details
-
getIpv6EroBackup
Return current value associated with the property corresponding toIpv6EroBackupCase.getIpv6EroBackup()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6EroBackupCase>> 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
-
setIpv6EroBackup
Set the property corresponding toIpv6EroBackupCase.getIpv6EroBackup()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Ipv6EroBackupCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6EroBackupCase> 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 Ipv6EroBackupCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6EroBackupCase>> 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 newIpv6EroBackupCase
instance.- Returns:
- A new
Ipv6EroBackupCase
instance.
-