Class PathKeyBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.path.key.object.PathKeyBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PathKey>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PathKey,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PathKeyBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PathKey>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description PathKeyBuilder()
PathKeyBuilder(Object arg)
PathKeyBuilder(ObjectHeader arg)
PathKeyBuilder(PathKey base)
-
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)
PathKey
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getIgnore()
List<PathKeys>
getPathKeys()
Boolean
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)
PathKeyBuilder
setPathKeys(List<PathKeys> values)
PathKeyBuilder
setProcessingRule(Boolean value)
-
-
-
Constructor Detail
-
PathKeyBuilder
public PathKeyBuilder()
-
PathKeyBuilder
public PathKeyBuilder(Object arg)
-
PathKeyBuilder
public PathKeyBuilder(ObjectHeader arg)
-
PathKeyBuilder
public PathKeyBuilder(PathKey base)
-
-
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:- ObjectHeader
- Object
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getIgnore
public Boolean getIgnore()
-
getProcessingRule
public Boolean getProcessingRule()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PathKey>> E$$ augmentation(Class<E$$> augmentationType)
-
setIgnore
public PathKeyBuilder setIgnore(Boolean value)
-
setPathKeys
public PathKeyBuilder setPathKeys(List<PathKeys> values)
-
setProcessingRule
public PathKeyBuilder setProcessingRule(Boolean value)
-
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
-
build
public PathKey build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PathKey>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PathKey,IllegalArgumentException>
-
-