Class Ipv6PrefixBinaryBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.augmented.lisp.address.address.Ipv6PrefixBinaryBuilder
-
@Generated("mdsal-binding-generator") public class Ipv6PrefixBinaryBuilder extends java.lang.Object
Class that buildsIpv6PrefixBinary
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:
Ipv6PrefixBinary createIpv6PrefixBinary(int fooXyzzy, int barBaz) { return new Ipv6PrefixBinaryBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv6PrefixBinary, 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:
Ipv6PrefixBinary
- 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 Ipv6PrefixBinaryBuilder()
Construct an empty builder.Ipv6PrefixBinaryBuilder(Ipv6PrefixBinary base)
Construct a builder initialized with state from specifiedIpv6PrefixBinary
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Ipv6PrefixBinaryBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6PrefixBinary> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6PrefixBinary>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Ipv6PrefixBinary
build()
A newIpv6PrefixBinary
instance.Ipv6AddressBinary
getIpv6AddressBinary()
Return current value associated with the property corresponding toIpv6PrefixBinary.getIpv6AddressBinary()
.org.opendaylight.yangtools.yang.common.Uint8
getIpv6MaskLength()
Return current value associated with the property corresponding toIpv6PrefixBinary.getIpv6MaskLength()
.Ipv6PrefixBinaryBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6PrefixBinary>> augmentationType)
Remove an augmentation from this builder's product.Ipv6PrefixBinaryBuilder
setIpv6AddressBinary(Ipv6AddressBinary value)
Set the property corresponding toIpv6PrefixBinary.getIpv6AddressBinary()
to the specified value.Ipv6PrefixBinaryBuilder
setIpv6MaskLength(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toIpv6PrefixBinary.getIpv6MaskLength()
to the specified value.
-
-
-
Constructor Detail
-
Ipv6PrefixBinaryBuilder
public Ipv6PrefixBinaryBuilder()
Construct an empty builder.
-
Ipv6PrefixBinaryBuilder
public Ipv6PrefixBinaryBuilder(Ipv6PrefixBinary base)
Construct a builder initialized with state from specifiedIpv6PrefixBinary
.- Parameters:
base
- Ipv6PrefixBinary from which the builder should be initialized
-
-
Method Detail
-
getIpv6AddressBinary
public Ipv6AddressBinary getIpv6AddressBinary()
Return current value associated with the property corresponding toIpv6PrefixBinary.getIpv6AddressBinary()
.- Returns:
- current value
-
getIpv6MaskLength
public org.opendaylight.yangtools.yang.common.Uint8 getIpv6MaskLength()
Return current value associated with the property corresponding toIpv6PrefixBinary.getIpv6MaskLength()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6PrefixBinary>> 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
-
setIpv6AddressBinary
public Ipv6PrefixBinaryBuilder setIpv6AddressBinary(Ipv6AddressBinary value)
Set the property corresponding toIpv6PrefixBinary.getIpv6AddressBinary()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIpv6MaskLength
public Ipv6PrefixBinaryBuilder setIpv6MaskLength(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toIpv6PrefixBinary.getIpv6MaskLength()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Ipv6PrefixBinaryBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6PrefixBinary> 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 Ipv6PrefixBinaryBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6PrefixBinary>> 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 Ipv6PrefixBinary build()
A newIpv6PrefixBinary
instance.- Returns:
- A new
Ipv6PrefixBinary
instance.
-
-