Class SymbolicPathNameBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.symbolic.path.name.tlv.SymbolicPathNameBuilder
Class that builds
SymbolicPathName
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:
SymbolicPathName createSymbolicPathName(int fooXyzzy, int barBaz) {
return new SymbolicPathNameBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of SymbolicPathName, 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
ConstructorsConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedSymbolicPathName
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<SymbolicPathName> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<SymbolicPathName>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull SymbolicPathName
build()
A newSymbolicPathName
instance.static @NonNull SymbolicPathName
empty()
Get empty instance of SymbolicPathName.Return current value associated with the property corresponding toSymbolicPathName.getPathName()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<SymbolicPathName>> augmentationType) Remove an augmentation from this builder's product.setPathName
(SymbolicPathName value) Set the property corresponding toSymbolicPathName.getPathName()
to the specified value.
-
Constructor Details
-
SymbolicPathNameBuilder
public SymbolicPathNameBuilder()Construct an empty builder. -
SymbolicPathNameBuilder
Construct a builder initialized with state from specifiedSymbolicPathName
.- Parameters:
base
- SymbolicPathName from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of SymbolicPathName.- Returns:
- An empty
SymbolicPathName
-
getPathName
Return current value associated with the property corresponding toSymbolicPathName.getPathName()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<SymbolicPathName>> 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
-
setPathName
Set the property corresponding toSymbolicPathName.getPathName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SymbolicPathNameBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<SymbolicPathName> 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 SymbolicPathNameBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<SymbolicPathName>> 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 newSymbolicPathName
instance.- Returns:
- A new
SymbolicPathName
instance.
-