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