Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.initiated.rev200720
Class PcinitiateBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.initiated.rev200720.PcinitiateBuilder
-
@Generated("mdsal-binding-generator") public class PcinitiateBuilder extends Object
Class that buildsPcinitiate
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:
Pcinitiate createPcinitiate(int fooXyzzy, int barBaz) { return new PcinitiateBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Pcinitiate, 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:
Pcinitiate
- 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 PcinitiateBuilder()
Construct an empty builder.PcinitiateBuilder(Pcinitiate base)
Construct a builder initialized with state from specifiedPcinitiate
.PcinitiateBuilder(PcinitiateMessage arg)
Construct a new builder initialized from specifiedPcinitiateMessage
.PcinitiateBuilder(Message arg)
Construct a new builder initialized from specifiedMessage
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PcinitiateBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Pcinitiate> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Pcinitiate>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Pcinitiate
build()
A newPcinitiate
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.PcinitiateMessage
getPcinitiateMessage()
Return current value associated with the property corresponding toPcinitiateMessage.getPcinitiateMessage()
.PcinitiateBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Pcinitiate>> augmentationType)
Remove an augmentation from this builder's product.PcinitiateBuilder
setPcinitiateMessage(PcinitiateMessage value)
Set the property corresponding toPcinitiateMessage.getPcinitiateMessage()
to the specified value.
-
-
-
Constructor Detail
-
PcinitiateBuilder
public PcinitiateBuilder()
Construct an empty builder.
-
PcinitiateBuilder
public PcinitiateBuilder(PcinitiateMessage arg)
Construct a new builder initialized from specifiedPcinitiateMessage
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.initiated.rev200720.PcinitiateMessage from which the builder should be initialized
-
PcinitiateBuilder
public PcinitiateBuilder(Message arg)
Construct a new builder initialized from specifiedMessage
.- Parameters:
arg
- Message from which the builder should be initialized
-
PcinitiateBuilder
public PcinitiateBuilder(Pcinitiate base)
Construct a builder initialized with state from specifiedPcinitiate
.- Parameters:
base
- Pcinitiate 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
-
getPcinitiateMessage
public PcinitiateMessage getPcinitiateMessage()
Return current value associated with the property corresponding toPcinitiateMessage.getPcinitiateMessage()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Pcinitiate>> 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
-
setPcinitiateMessage
public PcinitiateBuilder setPcinitiateMessage(PcinitiateMessage value)
Set the property corresponding toPcinitiateMessage.getPcinitiateMessage()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PcinitiateBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Pcinitiate> 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 PcinitiateBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Pcinitiate>> 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 Pcinitiate build()
A newPcinitiate
instance.- Returns:
- A new
Pcinitiate
instance.
-
-