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