Class PcupdMessageBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.pcupd.message.PcupdMessageBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PcupdMessage>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PcupdMessage,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PcupdMessageBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PcupdMessage>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description PcupdMessageBuilder()
PcupdMessageBuilder(PcupdMessage base)
PcupdMessageBuilder(MessageHeader arg)
-
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)
PcupdMessage
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<Updates>
getUpdates()
ProtocolVersion
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)
PcupdMessageBuilder
setVersion(ProtocolVersion value)
-
-
-
Constructor Detail
-
PcupdMessageBuilder
public PcupdMessageBuilder()
-
PcupdMessageBuilder
public PcupdMessageBuilder(MessageHeader arg)
-
PcupdMessageBuilder
public PcupdMessageBuilder(PcupdMessage 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
-
getVersion
public ProtocolVersion getVersion()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PcupdMessage>> E$$ augmentation(Class<E$$> augmentationType)
-
setUpdates
public PcupdMessageBuilder setUpdates(List<Updates> values)
-
setVersion
public PcupdMessageBuilder setVersion(ProtocolVersion value)
-
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 PcupdMessage build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PcupdMessage>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PcupdMessage,IllegalArgumentException>
-
-