Class PathKeyBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.path.key.object.PathKeyBuilder
-
@Generated("mdsal-binding-generator") public class PathKeyBuilder extends Object
Class that buildsPathKey
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:
PathKey createPathKey(int fooXyzzy, int barBaz) { return new PathKeyBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PathKey, 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:
PathKey
- 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
-
-
Constructor Summary
Constructors Constructor Description PathKeyBuilder()
Construct an empty builder.PathKeyBuilder(Object arg)
Construct a new builder initialized from specifiedObject
.PathKeyBuilder(ObjectHeader arg)
Construct a new builder initialized from specifiedObjectHeader
.PathKeyBuilder(PathKey base)
Construct a builder initialized with state from specifiedPathKey
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PathKeyBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PathKey> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PathKey>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PathKey
build()
A newPathKey
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getIgnore()
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.List<PathKeys>
getPathKeys()
Return current value associated with the property corresponding toPathKey.getPathKeys()
.Boolean
getProcessingRule()
Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.PathKeyBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PathKey>> augmentationType)
Remove an augmentation from this builder's product.PathKeyBuilder
setIgnore(Boolean value)
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.PathKeyBuilder
setPathKeys(List<PathKeys> values)
Set the property corresponding toPathKey.getPathKeys()
to the specified value.PathKeyBuilder
setProcessingRule(Boolean value)
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.
-
-
-
Constructor Detail
-
PathKeyBuilder
public PathKeyBuilder()
Construct an empty builder.
-
PathKeyBuilder
public PathKeyBuilder(Object arg)
Construct a new builder initialized from specifiedObject
.- Parameters:
arg
- Object from which the builder should be initialized
-
PathKeyBuilder
public PathKeyBuilder(ObjectHeader arg)
Construct a new builder initialized from specifiedObjectHeader
.- Parameters:
arg
- ObjectHeader from which the builder should be initialized
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getIgnore
public Boolean getIgnore()
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.- Returns:
- current value
-
getPathKeys
public List<PathKeys> getPathKeys()
Return current value associated with the property corresponding toPathKey.getPathKeys()
.- Returns:
- current value
-
getProcessingRule
public Boolean getProcessingRule()
Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PathKey>> 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
-
setIgnore
public PathKeyBuilder setIgnore(Boolean value)
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPathKeys
public PathKeyBuilder setPathKeys(List<PathKeys> values)
Set the property corresponding toPathKey.getPathKeys()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setProcessingRule
public PathKeyBuilder setProcessingRule(Boolean value)
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PathKeyBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PathKey> 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 PathKeyBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PathKey>> 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
-
-