Class PathKeyCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.explicit.route.subobjects.subobject.type.PathKeyCaseBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PathKeyCase>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PathKeyCase,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PathKeyCaseBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PathKeyCase>
Class that buildsPathKeyCase
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:
PathKeyCase createPathKeyCase(int fooXyzzy, int barBaz) { return new PathKeyCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PathKeyCase, 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:
PathKeyCase
,Builder
-
-
Constructor Summary
Constructors Constructor Description PathKeyCaseBuilder()
PathKeyCaseBuilder(PathKeyCase base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PathKeyCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PathKeyCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PathKeyCase>>
E$$augmentation(Class<E$$> augmentationType)
PathKeyCase
build()
PathKey
getPathKey()
PathKeyCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PathKeyCase>> augmentationType)
Remove an augmentation from this builder's product.PathKeyCaseBuilder
setPathKey(PathKey value)
-
-
-
Constructor Detail
-
PathKeyCaseBuilder
public PathKeyCaseBuilder()
-
PathKeyCaseBuilder
public PathKeyCaseBuilder(PathKeyCase base)
-
-
Method Detail
-
getPathKey
public PathKey getPathKey()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PathKeyCase>> E$$ augmentation(Class<E$$> augmentationType)
-
setPathKey
public PathKeyCaseBuilder setPathKey(PathKey value)
-
addAugmentation
public PathKeyCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PathKeyCase> 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 PathKeyCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PathKeyCase>> 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 PathKeyCase build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PathKeyCase>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PathKeyCase,IllegalArgumentException>
-
-