Class NullAddressBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.NullAddressBuilder
Class that builds
NullAddress
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:
NullAddress createNullAddress(int fooXyzzy, int barBaz) {
return new NullAddressBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of NullAddress, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedNullAddress
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<NullAddress> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NullAddress>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull NullAddress
build()
A newNullAddress
instance.Return current value associated with the property corresponding toNullAddress.getNullAddress()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NullAddress>> augmentationType) Remove an augmentation from this builder's product.setNullAddress
(NullAddress value) Set the property corresponding toNullAddress.getNullAddress()
to the specified value.
-
Constructor Details
-
NullAddressBuilder
public NullAddressBuilder()Construct an empty builder. -
NullAddressBuilder
Construct a builder initialized with state from specifiedNullAddress
.- Parameters:
base
- NullAddress from which the builder should be initialized
-
-
Method Details
-
getNullAddress
Return current value associated with the property corresponding toNullAddress.getNullAddress()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NullAddress>> E$$ augmentation(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:
NullPointerException
- ifaugmentType
isnull
-
setNullAddress
Set the property corresponding toNullAddress.getNullAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public NullAddressBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NullAddress> augmentation) Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public NullAddressBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NullAddress>> 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
A newNullAddress
instance.- Returns:
- A new
NullAddress
instance.
-