Class PathBindingBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.path.binding.tlv.PathBindingBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PathBinding>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PathBinding,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PathBindingBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PathBinding>
Class that buildsPathBindingBuilder
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:
PathBindingBuilder createTarget(int fooXyzzy, int barBaz) { return new PathBindingBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PathBindingBuilder, 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:
PathBindingBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PathBindingBuilder()
PathBindingBuilder(PathBinding base)
PathBindingBuilder(Tlv arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PathBindingBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PathBinding> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PathBinding>>
E$$augmentation(Class<E$$> augmentationType)
PathBinding
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.BindingTypeValue
getBindingTypeValue()
PathBindingBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PathBinding>> augmentationType)
Remove an augmentation from this builder's product.PathBindingBuilder
setBindingTypeValue(BindingTypeValue value)
-
-
-
Constructor Detail
-
PathBindingBuilder
public PathBindingBuilder()
-
PathBindingBuilder
public PathBindingBuilder(Tlv arg)
-
PathBindingBuilder
public PathBindingBuilder(PathBinding 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.Tlv
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getBindingTypeValue
public BindingTypeValue getBindingTypeValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PathBinding>> E$$ augmentation(Class<E$$> augmentationType)
-
setBindingTypeValue
public PathBindingBuilder setBindingTypeValue(BindingTypeValue value)
-
addAugmentation
public PathBindingBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PathBinding> 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 PathBindingBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PathBinding>> 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 PathBinding build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PathBinding>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PathBinding,IllegalArgumentException>
-
-