Class ExperimenterMessageBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterMessageBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ExperimenterMessage>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ExperimenterMessage,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ExperimenterMessageBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ExperimenterMessage>
Class that buildsExperimenterMessage
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:
ExperimenterMessage createExperimenterMessage(int fooXyzzy, int barBaz) { return new ExperimenterMessageBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ExperimenterMessage, 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:
ExperimenterMessage
,Builder
-
-
Constructor Summary
Constructors Constructor Description ExperimenterMessageBuilder()
ExperimenterMessageBuilder(ExperimenterCore arg)
ExperimenterMessageBuilder(ExperimenterMessage base)
ExperimenterMessageBuilder(ExperimenterOfMessage arg)
ExperimenterMessageBuilder(OfHeader arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ExperimenterMessageBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterMessage> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterMessage>>
E$$augmentation(Class<E$$> augmentationType)
ExperimenterMessage
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.ExperimenterId
getExperimenter()
ExperimenterDataOfChoice
getExperimenterDataOfChoice()
org.opendaylight.yangtools.yang.common.Uint32
getExpType()
org.opendaylight.yangtools.yang.common.Uint8
getVersion()
org.opendaylight.yangtools.yang.common.Uint32
getXid()
ExperimenterMessageBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterMessage>> augmentationType)
Remove an augmentation from this builder's product.ExperimenterMessageBuilder
setExperimenter(ExperimenterId value)
ExperimenterMessageBuilder
setExperimenterDataOfChoice(ExperimenterDataOfChoice value)
ExperimenterMessageBuilder
setExpType(org.opendaylight.yangtools.yang.common.Uint32 value)
ExperimenterMessageBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
ExperimenterMessageBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
ExperimenterMessageBuilder
public ExperimenterMessageBuilder()
-
ExperimenterMessageBuilder
public ExperimenterMessageBuilder(ExperimenterOfMessage arg)
-
ExperimenterMessageBuilder
public ExperimenterMessageBuilder(OfHeader arg)
-
ExperimenterMessageBuilder
public ExperimenterMessageBuilder(ExperimenterCore arg)
-
ExperimenterMessageBuilder
public ExperimenterMessageBuilder(ExperimenterMessage 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:- ExperimenterCore
- OfHeader
- ExperimenterOfMessage
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getExpType
public org.opendaylight.yangtools.yang.common.Uint32 getExpType()
-
getExperimenter
public ExperimenterId getExperimenter()
-
getExperimenterDataOfChoice
public ExperimenterDataOfChoice getExperimenterDataOfChoice()
-
getVersion
public org.opendaylight.yangtools.yang.common.Uint8 getVersion()
-
getXid
public org.opendaylight.yangtools.yang.common.Uint32 getXid()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterMessage>> E$$ augmentation(Class<E$$> augmentationType)
-
setExpType
public ExperimenterMessageBuilder setExpType(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setExperimenter
public ExperimenterMessageBuilder setExperimenter(ExperimenterId value)
-
setExperimenterDataOfChoice
public ExperimenterMessageBuilder setExperimenterDataOfChoice(ExperimenterDataOfChoice value)
-
setVersion
public ExperimenterMessageBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setXid
public ExperimenterMessageBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
addAugmentation
public ExperimenterMessageBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterMessage> 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 ExperimenterMessageBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterMessage>> 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 ExperimenterMessage build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ExperimenterMessage>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ExperimenterMessage,IllegalArgumentException>
-
-