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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PcreqMessage>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PcreqMessage,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PcreqMessageBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PcreqMessage>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description PcreqMessageBuilder()
PcreqMessageBuilder(MessageHeader arg)
PcreqMessageBuilder(PcreqMessage base)
-
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)
PcreqMessage
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.MonitoringRequest
getMonitoringRequest()
List<Requests>
getRequests()
List<Svec>
getSvec()
ProtocolVersion
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)
PcreqMessageBuilder
setRequests(List<Requests> values)
PcreqMessageBuilder
setSvec(List<Svec> values)
PcreqMessageBuilder
setVersion(ProtocolVersion value)
-
-
-
Constructor Detail
-
PcreqMessageBuilder
public PcreqMessageBuilder()
-
PcreqMessageBuilder
public PcreqMessageBuilder(MessageHeader arg)
-
PcreqMessageBuilder
public PcreqMessageBuilder(PcreqMessage base)
-
-
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:- MessageHeader
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getMonitoringRequest
public MonitoringRequest getMonitoringRequest()
-
getVersion
public ProtocolVersion getVersion()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PcreqMessage>> E$$ augmentation(Class<E$$> augmentationType)
-
setMonitoringRequest
public PcreqMessageBuilder setMonitoringRequest(MonitoringRequest value)
-
setRequests
public PcreqMessageBuilder setRequests(List<Requests> values)
-
setSvec
public PcreqMessageBuilder setSvec(List<Svec> values)
-
setVersion
public PcreqMessageBuilder setVersion(ProtocolVersion value)
-
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 PcreqMessage build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PcreqMessage>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PcreqMessage,IllegalArgumentException>
-
-