Class Ipv6PrefixBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.Ipv6PrefixBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Ipv6Prefix>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Ipv6Prefix,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class Ipv6PrefixBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Ipv6Prefix>
Class that buildsIpv6PrefixBuilder
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:
Ipv6PrefixBuilder createTarget(int fooXyzzy, int barBaz) { return new Ipv6PrefixBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv6PrefixBuilder, 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 oportunities, 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:
Ipv6PrefixBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description Ipv6PrefixBuilder()
Ipv6PrefixBuilder(Ipv6Prefix base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Ipv6PrefixBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Prefix>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Prefix> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Ipv6PrefixBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Prefix> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Prefix>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Ipv6Prefix
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix
getIpv6Prefix()
Ipv6PrefixBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Prefix>> augmentationType)
Remove an augmentation from this builder's product.Ipv6PrefixBuilder
setIpv6Prefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix value)
-
-
-
Constructor Detail
-
Ipv6PrefixBuilder
public Ipv6PrefixBuilder()
-
Ipv6PrefixBuilder
public Ipv6PrefixBuilder(Ipv6Prefix base)
-
-
Method Detail
-
getIpv6Prefix
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix getIpv6Prefix()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Prefix>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setIpv6Prefix
public Ipv6PrefixBuilder setIpv6Prefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix value)
-
addAugmentation
public Ipv6PrefixBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Prefix> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public Ipv6PrefixBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Prefix>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Prefix> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public Ipv6PrefixBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Prefix>> 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 Ipv6Prefix build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Ipv6Prefix>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Ipv6Prefix,java.lang.IllegalArgumentException>
-
-