Class Ipv6Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.address.address.Ipv6Builder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Ipv6>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Ipv6,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class Ipv6Builder extends Object implements org.opendaylight.yangtools.concepts.Builder<Ipv6>
Class that buildsIpv6
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:
Ipv6 createIpv6(int fooXyzzy, int barBaz) { return new Ipv6Builder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv6, 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:
Ipv6
,Builder
-
-
Constructor Summary
Constructors Constructor Description Ipv6Builder()
Ipv6Builder(Ipv6 base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Ipv6Builder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6>>
E$$augmentation(Class<E$$> augmentationType)
Ipv6
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix
getIpv6Address()
Ipv6Builder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6>> augmentationType)
Remove an augmentation from this builder's product.Ipv6Builder
setIpv6Address(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix value)
-
-
-
Constructor Detail
-
Ipv6Builder
public Ipv6Builder()
-
Ipv6Builder
public Ipv6Builder(Ipv6 base)
-
-
Method Detail
-
getIpv6Address
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix getIpv6Address()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6>> E$$ augmentation(Class<E$$> augmentationType)
-
setIpv6Address
public Ipv6Builder setIpv6Address(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix value)
-
addAugmentation
public Ipv6Builder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6> 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 Ipv6Builder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6>> 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 Ipv6 build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Ipv6>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Ipv6,IllegalArgumentException>
-
-