Class Ipv6SidTlvBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv6.routes.ipv6.routes.ipv6.route.attributes.bgp.prefix.sid.bgp.prefix.sid.tlvs.bgp.prefix.sid.tlv.Ipv6SidTlvBuilder
-
@Generated("mdsal-binding-generator") public class Ipv6SidTlvBuilder extends Object
Class that buildsIpv6SidTlv
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:
Ipv6SidTlv createIpv6SidTlv(int fooXyzzy, int barBaz) { return new Ipv6SidTlvBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv6SidTlv, 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:
Ipv6SidTlv
- 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 Ipv6SidTlvBuilder()
Construct an empty builder.Ipv6SidTlvBuilder(Ipv6SidTlv base)
Construct a builder initialized with state from specifiedIpv6SidTlv
.Ipv6SidTlvBuilder(Ipv6BgpPrefixSidTlv arg)
Construct a new builder initialized from specifiedIpv6BgpPrefixSidTlv
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Ipv6SidTlvBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6SidTlv> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6SidTlv>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Ipv6SidTlv
build()
A newIpv6SidTlv
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getProcessIpv6HeadAbility()
Return current value associated with the property corresponding toIpv6BgpPrefixSidTlv.getProcessIpv6HeadAbility()
.Ipv6SidTlvBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6SidTlv>> augmentationType)
Remove an augmentation from this builder's product.Ipv6SidTlvBuilder
setProcessIpv6HeadAbility(Boolean value)
Set the property corresponding toIpv6BgpPrefixSidTlv.getProcessIpv6HeadAbility()
to the specified value.
-
-
-
Constructor Detail
-
Ipv6SidTlvBuilder
public Ipv6SidTlvBuilder()
Construct an empty builder.
-
Ipv6SidTlvBuilder
public Ipv6SidTlvBuilder(Ipv6BgpPrefixSidTlv arg)
Construct a new builder initialized from specifiedIpv6BgpPrefixSidTlv
.- Parameters:
arg
- Ipv6BgpPrefixSidTlv from which the builder should be initialized
-
Ipv6SidTlvBuilder
public Ipv6SidTlvBuilder(Ipv6SidTlv base)
Construct a builder initialized with state from specifiedIpv6SidTlv
.- Parameters:
base
- Ipv6SidTlv 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
-
getProcessIpv6HeadAbility
public Boolean getProcessIpv6HeadAbility()
Return current value associated with the property corresponding toIpv6BgpPrefixSidTlv.getProcessIpv6HeadAbility()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6SidTlv>> 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
-
setProcessIpv6HeadAbility
public Ipv6SidTlvBuilder setProcessIpv6HeadAbility(Boolean value)
Set the property corresponding toIpv6BgpPrefixSidTlv.getProcessIpv6HeadAbility()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Ipv6SidTlvBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6SidTlv> 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 Ipv6SidTlvBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6SidTlv>> 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 Ipv6SidTlv build()
A newIpv6SidTlv
instance.- Returns:
- A new
Ipv6SidTlv
instance.
-
-