Class Ipv6SrPrefixBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.prefix.state.Ipv6SrPrefixBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Ipv6SrPrefix>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Ipv6SrPrefix,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class Ipv6SrPrefixBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Ipv6SrPrefix>
Class that buildsIpv6SrPrefix
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:
Ipv6SrPrefix createIpv6SrPrefix(int fooXyzzy, int barBaz) { return new Ipv6SrPrefixBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv6SrPrefix, 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:
Ipv6SrPrefix
,Builder
-
-
Constructor Summary
Constructors Constructor Description Ipv6SrPrefixBuilder()
Ipv6SrPrefixBuilder(Ipv6SrPrefix base)
Ipv6SrPrefixBuilder(Ipv6PrefixSidTlv arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Ipv6SrPrefixBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6SrPrefix> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6SrPrefix>>
E$$augmentation(Class<E$$> augmentationType)
Ipv6SrPrefix
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Algorithm
getAlgorithm()
Ipv6SrPrefixBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6SrPrefix>> augmentationType)
Remove an augmentation from this builder's product.Ipv6SrPrefixBuilder
setAlgorithm(Algorithm value)
-
-
-
Constructor Detail
-
Ipv6SrPrefixBuilder
public Ipv6SrPrefixBuilder()
-
Ipv6SrPrefixBuilder
public Ipv6SrPrefixBuilder(Ipv6PrefixSidTlv arg)
-
Ipv6SrPrefixBuilder
public Ipv6SrPrefixBuilder(Ipv6SrPrefix base)
-
-
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:- Ipv6PrefixSidTlv
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getAlgorithm
public Algorithm getAlgorithm()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6SrPrefix>> E$$ augmentation(Class<E$$> augmentationType)
-
setAlgorithm
public Ipv6SrPrefixBuilder setAlgorithm(Algorithm value)
-
addAugmentation
public Ipv6SrPrefixBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6SrPrefix> 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 Ipv6SrPrefixBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6SrPrefix>> 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 Ipv6SrPrefix build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Ipv6SrPrefix>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Ipv6SrPrefix,IllegalArgumentException>
-
-