Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcrep.message
Class PcrepMessageBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcrep.message.PcrepMessageBuilder
-
@Generated("mdsal-binding-generator") public class PcrepMessageBuilder extends Object
Class that buildsPcrepMessage
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:
PcrepMessage createPcrepMessage(int fooXyzzy, int barBaz) { return new PcrepMessageBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PcrepMessage, 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:
PcrepMessage
- 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 PcrepMessageBuilder()
Construct an empty builder.PcrepMessageBuilder(MessageHeader arg)
Construct a new builder initialized from specifiedMessageHeader
.PcrepMessageBuilder(PcrepMessage base)
Construct a builder initialized with state from specifiedPcrepMessage
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PcrepMessageBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PcrepMessage> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PcrepMessage>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PcrepMessage
build()
A newPcrepMessage
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<Replies>
getReplies()
Return current value associated with the property corresponding toPcrepMessage.getReplies()
.ProtocolVersion
getVersion()
Return current value associated with the property corresponding toMessageHeader.getVersion()
.PcrepMessageBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcrepMessage>> augmentationType)
Remove an augmentation from this builder's product.PcrepMessageBuilder
setReplies(List<Replies> values)
Set the property corresponding toPcrepMessage.getReplies()
to the specified value.PcrepMessageBuilder
setVersion(ProtocolVersion value)
Set the property corresponding toMessageHeader.getVersion()
to the specified value.
-
-
-
Constructor Detail
-
PcrepMessageBuilder
public PcrepMessageBuilder()
Construct an empty builder.
-
PcrepMessageBuilder
public PcrepMessageBuilder(MessageHeader arg)
Construct a new builder initialized from specifiedMessageHeader
.- Parameters:
arg
- MessageHeader from which the builder should be initialized
-
PcrepMessageBuilder
public PcrepMessageBuilder(PcrepMessage base)
Construct a builder initialized with state from specifiedPcrepMessage
.- Parameters:
base
- PcrepMessage 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
-
getReplies
public List<Replies> getReplies()
Return current value associated with the property corresponding toPcrepMessage.getReplies()
.- Returns:
- current value
-
getVersion
public ProtocolVersion getVersion()
Return current value associated with the property corresponding toMessageHeader.getVersion()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PcrepMessage>> 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
-
setReplies
public PcrepMessageBuilder setReplies(List<Replies> values)
Set the property corresponding toPcrepMessage.getReplies()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setVersion
public PcrepMessageBuilder setVersion(ProtocolVersion value)
Set the property corresponding toMessageHeader.getVersion()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PcrepMessageBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PcrepMessage> 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 PcrepMessageBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcrepMessage>> 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 PcrepMessage build()
A newPcrepMessage
instance.- Returns:
- A new
PcrepMessage
instance.
-
-