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
Class that builds
PcreqMessage
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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedMessageHeader
.Construct a builder initialized with state from specifiedPcreqMessage
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(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.static @NonNull PcreqMessage
empty()
Get empty instance of PcreqMessage.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toPcreqMessage.getMonitoringRequest()
.Return current value associated with the property corresponding toPcreqMessage.getRequests()
.getSvec()
Return current value associated with the property corresponding toPcreqMessage.getSvec()
.Return current value associated with the property corresponding toMessageHeader.getVersion()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcreqMessage>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toPcreqMessage.getMonitoringRequest()
to the specified value.setRequests
(List<Requests> values) Set the property corresponding toPcreqMessage.getRequests()
to the specified value.Set the property corresponding toPcreqMessage.getSvec()
to the specified value.setVersion
(ProtocolVersion value) Set the property corresponding toMessageHeader.getVersion()
to the specified value.
-
Constructor Details
-
PcreqMessageBuilder
public PcreqMessageBuilder()Construct an empty builder. -
PcreqMessageBuilder
Construct a new builder initialized from specifiedMessageHeader
.- Parameters:
arg
- MessageHeader from which the builder should be initialized
-
PcreqMessageBuilder
Construct a builder initialized with state from specifiedPcreqMessage
.- Parameters:
base
- PcreqMessage from which the builder should be initialized
-
-
Method Details
-
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
-
empty
Get empty instance of PcreqMessage.- Returns:
- An empty
PcreqMessage
-
getMonitoringRequest
Return current value associated with the property corresponding toPcreqMessage.getMonitoringRequest()
.- Returns:
- current value
-
getRequests
Return current value associated with the property corresponding toPcreqMessage.getRequests()
.- Returns:
- current value
-
getSvec
Return current value associated with the property corresponding toPcreqMessage.getSvec()
.- Returns:
- current value
-
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
Set the property corresponding toPcreqMessage.getMonitoringRequest()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRequests
Set the property corresponding toPcreqMessage.getRequests()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setSvec
Set the property corresponding toPcreqMessage.getSvec()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setVersion
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
A newPcreqMessage
instance.- Returns:
- A new
PcreqMessage
instance.
-