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