Class InstanceIdBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.instance.id.InstanceIdBuilder
Class that builds
InstanceId
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:
InstanceId createInstanceId(int fooXyzzy, int barBaz) {
return new InstanceIdBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of InstanceId, 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.InstanceIdBuilder
(InstanceId base) Construct a builder initialized with state from specifiedInstanceId
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<InstanceId> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InstanceId>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull InstanceId
build()
A newInstanceId
instance.static @NonNull InstanceId
empty()
Get empty instance of InstanceId.Return current value associated with the property corresponding toInstanceId.getAddress()
.getIid()
Return current value associated with the property corresponding toInstanceId.getIid()
.org.opendaylight.yangtools.yang.common.Uint8
Return current value associated with the property corresponding toInstanceId.getMaskLength()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InstanceId>> augmentationType) Remove an augmentation from this builder's product.setAddress
(SimpleAddress value) Set the property corresponding toInstanceId.getAddress()
to the specified value.setIid
(InstanceIdType value) Set the property corresponding toInstanceId.getIid()
to the specified value.setMaskLength
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toInstanceId.getMaskLength()
to the specified value.
-
Constructor Details
-
InstanceIdBuilder
public InstanceIdBuilder()Construct an empty builder. -
InstanceIdBuilder
Construct a builder initialized with state from specifiedInstanceId
.- Parameters:
base
- InstanceId from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of InstanceId.- Returns:
- An empty
InstanceId
-
getAddress
Return current value associated with the property corresponding toInstanceId.getAddress()
.- Returns:
- current value
-
getIid
Return current value associated with the property corresponding toInstanceId.getIid()
.- Returns:
- current value
-
getMaskLength
public org.opendaylight.yangtools.yang.common.Uint8 getMaskLength()Return current value associated with the property corresponding toInstanceId.getMaskLength()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InstanceId>> 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
-
setAddress
Set the property corresponding toInstanceId.getAddress()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIid
Set the property corresponding toInstanceId.getIid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMaskLength
Set the property corresponding toInstanceId.getMaskLength()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public InstanceIdBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InstanceId> 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 InstanceIdBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InstanceId>> 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 newInstanceId
instance.- Returns:
- A new
InstanceId
instance.
-