Class NoPathVectorBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcrep.message.pcrep.message.replies.result.failure._case.no.path.tlvs.NoPathVectorBuilder
-
@Generated("mdsal-binding-generator") public class NoPathVectorBuilder extends Object
Class that buildsNoPathVector
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:
NoPathVector createNoPathVector(int fooXyzzy, int barBaz) { return new NoPathVectorBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NoPathVector, 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:
NoPathVector
- 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 NoPathVectorBuilder()
Construct an empty builder.NoPathVectorBuilder(NoPathVectorTlv arg)
Construct a new builder initialized from specifiedNoPathVectorTlv
.NoPathVectorBuilder(NoPathVector base)
Construct a builder initialized with state from specifiedNoPathVector
.NoPathVectorBuilder(Tlv arg)
Construct a new builder initialized from specifiedTlv
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NoPathVectorBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NoPathVector> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NoPathVector>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull NoPathVector
build()
A newNoPathVector
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.NoPathVectorTlv.Flags
getFlags()
Return current value associated with the property corresponding toNoPathVectorTlv.getFlags()
.NoPathVectorBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NoPathVector>> augmentationType)
Remove an augmentation from this builder's product.NoPathVectorBuilder
setFlags(NoPathVectorTlv.Flags value)
Set the property corresponding toNoPathVectorTlv.getFlags()
to the specified value.
-
-
-
Constructor Detail
-
NoPathVectorBuilder
public NoPathVectorBuilder()
Construct an empty builder.
-
NoPathVectorBuilder
public NoPathVectorBuilder(NoPathVectorTlv arg)
Construct a new builder initialized from specifiedNoPathVectorTlv
.- Parameters:
arg
- NoPathVectorTlv from which the builder should be initialized
-
NoPathVectorBuilder
public NoPathVectorBuilder(Tlv arg)
Construct a new builder initialized from specifiedTlv
.- Parameters:
arg
- Tlv from which the builder should be initialized
-
NoPathVectorBuilder
public NoPathVectorBuilder(NoPathVector base)
Construct a builder initialized with state from specifiedNoPathVector
.- Parameters:
base
- NoPathVector 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
-
getFlags
public NoPathVectorTlv.Flags getFlags()
Return current value associated with the property corresponding toNoPathVectorTlv.getFlags()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NoPathVector>> 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
-
setFlags
public NoPathVectorBuilder setFlags(NoPathVectorTlv.Flags value)
Set the property corresponding toNoPathVectorTlv.getFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public NoPathVectorBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NoPathVector> 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 NoPathVectorBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NoPathVector>> 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 NoPathVector build()
A newNoPathVector
instance.- Returns:
- A new
NoPathVector
instance.
-
-