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