Class PathKeyExpansionBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcreq.message.pcreq.message.requests.PathKeyExpansionBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PathKeyExpansion>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PathKeyExpansion,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class PathKeyExpansionBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PathKeyExpansion>
Class that buildsPathKeyExpansionBuilder
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:
PathKeyExpansionBuilder createTarget(int fooXyzzy, int barBaz) { return new PathKeyExpansionBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PathKeyExpansionBuilder, 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 oportunities, 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:
PathKeyExpansionBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PathKeyExpansionBuilder()
PathKeyExpansionBuilder(PathKeyObject arg)
PathKeyExpansionBuilder(PathKeyExpansion base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PathKeyExpansionBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PathKeyExpansion>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PathKeyExpansion> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PathKeyExpansion>>
E$$augmentation(Class<E$$> augmentationType)
PathKeyExpansion
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.PathKey
getPathKey()
PathKeyExpansionBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PathKeyExpansion>> augmentationType)
PathKeyExpansionBuilder
setPathKey(PathKey value)
-
-
-
Constructor Detail
-
PathKeyExpansionBuilder
public PathKeyExpansionBuilder()
-
PathKeyExpansionBuilder
public PathKeyExpansionBuilder(PathKeyObject arg)
-
PathKeyExpansionBuilder
public PathKeyExpansionBuilder(PathKeyExpansion 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.PathKeyObject
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getPathKey
public PathKey getPathKey()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PathKeyExpansion>> E$$ augmentation(Class<E$$> augmentationType)
-
setPathKey
public PathKeyExpansionBuilder setPathKey(PathKey value)
-
addAugmentation
public PathKeyExpansionBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PathKeyExpansion>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PathKeyExpansion> augmentationValue)
-
removeAugmentation
public PathKeyExpansionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PathKeyExpansion>> augmentationType)
-
build
public PathKeyExpansion build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PathKeyExpansion>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PathKeyExpansion,IllegalArgumentException>
-
-