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