Class Ipv6PrefixSidTlvBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev200120.range.sub.tlvs.range.sub.tlv.ipv6.prefix.sid.tlv._case.Ipv6PrefixSidTlvBuilder
Class that builds
Ipv6PrefixSidTlv
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:
Ipv6PrefixSidTlv createIpv6PrefixSidTlv(int fooXyzzy, int barBaz) {
return new Ipv6PrefixSidTlvBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Ipv6PrefixSidTlv, 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 new builder initialized from specifiedIpv6PrefixSidTlv
.Construct a builder initialized with state from specifiedIpv6PrefixSidTlv
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6PrefixSidTlv> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6PrefixSidTlv>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Ipv6PrefixSidTlv
build()
A newIpv6PrefixSidTlv
instance.static @NonNull Ipv6PrefixSidTlv
empty()
Get empty instance of Ipv6PrefixSidTlv.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toIpv6PrefixSidTlv.getAlgorithm()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6PrefixSidTlv>> augmentationType) Remove an augmentation from this builder's product.setAlgorithm
(Algorithm value) Set the property corresponding toIpv6PrefixSidTlv.getAlgorithm()
to the specified value.
-
Constructor Details
-
Ipv6PrefixSidTlvBuilder
public Ipv6PrefixSidTlvBuilder()Construct an empty builder. -
Ipv6PrefixSidTlvBuilder
Construct a new builder initialized from specifiedIpv6PrefixSidTlv
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.segment.routing.ext.rev200120.Ipv6PrefixSidTlv from which the builder should be initialized
-
Ipv6PrefixSidTlvBuilder
Construct a builder initialized with state from specifiedIpv6PrefixSidTlv
.- Parameters:
base
- Ipv6PrefixSidTlv 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 Ipv6PrefixSidTlv.- Returns:
- An empty
Ipv6PrefixSidTlv
-
getAlgorithm
Return current value associated with the property corresponding toIpv6PrefixSidTlv.getAlgorithm()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6PrefixSidTlv>> 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
-
setAlgorithm
Set the property corresponding toIpv6PrefixSidTlv.getAlgorithm()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Ipv6PrefixSidTlvBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6PrefixSidTlv> 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 Ipv6PrefixSidTlvBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6PrefixSidTlv>> 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 newIpv6PrefixSidTlv
instance.- Returns:
- A new
Ipv6PrefixSidTlv
instance.
-