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