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