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