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
-
@Generated("mdsal-binding-generator") public class Ipv6PrefixBuilder extends java.lang.Object
Class that buildsIpv6Prefix
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:
Ipv6Prefix createIpv6Prefix(int fooXyzzy, int barBaz) { return new Ipv6PrefixBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv6Prefix, 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:
Ipv6Prefix
- 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 Ipv6PrefixBuilder()
Construct an empty builder.Ipv6PrefixBuilder(Ipv6Prefix base)
Construct a builder initialized with state from specifiedIpv6Prefix
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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)
Return the specified augmentation, if it is present in this builder.@NonNull Ipv6Prefix
build()
A newIpv6Prefix
instance.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix
getIpv6Prefix()
Return current value associated with the property corresponding toIpv6Prefix.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)
Set the property corresponding toIpv6Prefix.getIpv6Prefix()
to the specified value.
-
-
-
Constructor Detail
-
Ipv6PrefixBuilder
public Ipv6PrefixBuilder()
Construct an empty builder.
-
Ipv6PrefixBuilder
public Ipv6PrefixBuilder(Ipv6Prefix base)
Construct a builder initialized with state from specifiedIpv6Prefix
.- Parameters:
base
- Ipv6Prefix from which the builder should be initialized
-
-
Method Detail
-
getIpv6Prefix
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix getIpv6Prefix()
Return current value associated with the property corresponding toIpv6Prefix.getIpv6Prefix()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Prefix>> E$$ augmentation(java.lang.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:
java.lang.NullPointerException
- ifaugmentType
isnull
-
setIpv6Prefix
public Ipv6PrefixBuilder setIpv6Prefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix value)
Set the property corresponding toIpv6Prefix.getIpv6Prefix()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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
-
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 @NonNull Ipv6Prefix build()
A newIpv6Prefix
instance.- Returns:
- A new
Ipv6Prefix
instance.
-
-