Class Ipv6EroBuilder
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.ipv6.ero._case.Ipv6EroBuilder
Class that builds
Ipv6Ero
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:
Ipv6Ero createIpv6Ero(int fooXyzzy, int barBaz) {
return new Ipv6EroBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Ipv6Ero, 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.Ipv6EroBuilder
(Ipv6Ero base) Construct a builder initialized with state from specifiedIpv6Ero
.Ipv6EroBuilder
(EroFlags arg) Construct a new builder initialized from specifiedEroFlags
.Construct a new builder initialized from specifiedEroIpv6Address
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Ero> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Ero>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Ipv6Ero
build()
A newIpv6Ero
instance.static @NonNull Ipv6Ero
empty()
Get empty instance of Ipv6Ero.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone
Return current value associated with the property corresponding toEroIpv6Address.getAddress()
.getLoose()
Return current value associated with the property corresponding toEroFlags.getLoose()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Ero>> augmentationType) Remove an augmentation from this builder's product.setAddress
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone value) Set the property corresponding toEroIpv6Address.getAddress()
to the specified value.Set the property corresponding toEroFlags.getLoose()
to the specified value.
-
Constructor Details
-
Ipv6EroBuilder
public Ipv6EroBuilder()Construct an empty builder. -
Ipv6EroBuilder
Construct a new builder initialized from specifiedEroIpv6Address
.- Parameters:
arg
- EroIpv6Address from which the builder should be initialized
-
Ipv6EroBuilder
Construct a new builder initialized from specifiedEroFlags
.- Parameters:
arg
- EroFlags from which the builder should be initialized
-
Ipv6EroBuilder
Construct a builder initialized with state from specifiedIpv6Ero
.- Parameters:
base
- Ipv6Ero from which the builder should be initialized
-
-
Method Details
-
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
-
empty
Get empty instance of Ipv6Ero.- Returns:
- An empty
Ipv6Ero
-
getAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone getAddress()Return current value associated with the property corresponding toEroIpv6Address.getAddress()
.- Returns:
- current value
-
getLoose
Return current value associated with the property corresponding toEroFlags.getLoose()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Ero>> 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
-
setAddress
public Ipv6EroBuilder setAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone value) Set the property corresponding toEroIpv6Address.getAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLoose
Set the property corresponding toEroFlags.getLoose()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Ipv6EroBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Ero> 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 Ipv6EroBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Ero>> 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 newIpv6Ero
instance.- Returns:
- A new
Ipv6Ero
instance.
-