Class PathBindingBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.path.binding.tlv.PathBindingBuilder
-
@Generated("mdsal-binding-generator") public class PathBindingBuilder extends Object
Class that buildsPathBinding
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:
PathBinding createPathBinding(int fooXyzzy, int barBaz) { return new PathBindingBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PathBinding, 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:
PathBinding
- 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 PathBindingBuilder()
Construct an empty builder.PathBindingBuilder(PathBinding base)
Construct a builder initialized with state from specifiedPathBinding
.PathBindingBuilder(Tlv arg)
Construct a new builder initialized from specifiedTlv
.
-
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)
Return the specified augmentation, if it is present in this builder.@NonNull PathBinding
build()
A newPathBinding
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.BindingTypeValue
getBindingTypeValue()
Return current value associated with the property corresponding toPathBinding.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)
Set the property corresponding toPathBinding.getBindingTypeValue()
to the specified value.
-
-
-
Constructor Detail
-
PathBindingBuilder
public PathBindingBuilder()
Construct an empty builder.
-
PathBindingBuilder
public PathBindingBuilder(Tlv arg)
Construct a new builder initialized from specifiedTlv
.- Parameters:
arg
- Tlv from which the builder should be initialized
-
PathBindingBuilder
public PathBindingBuilder(PathBinding base)
Construct a builder initialized with state from specifiedPathBinding
.- Parameters:
base
- PathBinding 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
-
getBindingTypeValue
public BindingTypeValue getBindingTypeValue()
Return current value associated with the property corresponding toPathBinding.getBindingTypeValue()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PathBinding>> 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
-
setBindingTypeValue
public PathBindingBuilder setBindingTypeValue(BindingTypeValue value)
Set the property corresponding toPathBinding.getBindingTypeValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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 @NonNull PathBinding build()
A newPathBinding
instance.- Returns:
- A new
PathBinding
instance.
-
-