Class ExperimenterMessageBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterMessageBuilder
Class that builds
ExperimenterMessage
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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedExperimenterCore
.Construct a builder initialized with state from specifiedExperimenterMessage
.Construct a new builder initialized from specifiedExperimenterOfMessage
.Construct a new builder initialized from specifiedOfHeader
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(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) Return the specified augmentation, if it is present in this builder.@NonNull ExperimenterMessage
build()
A newExperimenterMessage
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toExperimenterCore.getExperimenter()
.Return current value associated with the property corresponding toExperimenterCore.getExperimenterDataOfChoice()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toExperimenterCore.getExpType()
.org.opendaylight.yangtools.yang.common.Uint8
Return current value associated with the property corresponding toOfHeader.getVersion()
.org.opendaylight.yangtools.yang.common.Uint32
getXid()
Return current value associated with the property corresponding toOfHeader.getXid()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterMessage>> augmentationType) Remove an augmentation from this builder's product.setExperimenter
(ExperimenterId value) Set the property corresponding toExperimenterCore.getExperimenter()
to the specified value.Set the property corresponding toExperimenterCore.getExperimenterDataOfChoice()
to the specified value.setExpType
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toExperimenterCore.getExpType()
to the specified value.setVersion
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toOfHeader.getVersion()
to the specified value.setXid
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toOfHeader.getXid()
to the specified value.
-
Constructor Details
-
ExperimenterMessageBuilder
public ExperimenterMessageBuilder()Construct an empty builder. -
ExperimenterMessageBuilder
Construct a new builder initialized from specifiedExperimenterOfMessage
.- Parameters:
arg
- ExperimenterOfMessage from which the builder should be initialized
-
ExperimenterMessageBuilder
Construct a new builder initialized from specifiedOfHeader
.- Parameters:
arg
- OfHeader from which the builder should be initialized
-
ExperimenterMessageBuilder
Construct a new builder initialized from specifiedExperimenterCore
.- Parameters:
arg
- ExperimenterCore from which the builder should be initialized
-
ExperimenterMessageBuilder
Construct a builder initialized with state from specifiedExperimenterMessage
.- Parameters:
base
- ExperimenterMessage 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
-
getExpType
public org.opendaylight.yangtools.yang.common.Uint32 getExpType()Return current value associated with the property corresponding toExperimenterCore.getExpType()
.- Returns:
- current value
-
getExperimenter
Return current value associated with the property corresponding toExperimenterCore.getExperimenter()
.- Returns:
- current value
-
getExperimenterDataOfChoice
Return current value associated with the property corresponding toExperimenterCore.getExperimenterDataOfChoice()
.- Returns:
- current value
-
getVersion
public org.opendaylight.yangtools.yang.common.Uint8 getVersion()Return current value associated with the property corresponding toOfHeader.getVersion()
.- Returns:
- current value
-
getXid
public org.opendaylight.yangtools.yang.common.Uint32 getXid()Return current value associated with the property corresponding toOfHeader.getXid()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExperimenterMessage>> 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
-
setExpType
Set the property corresponding toExperimenterCore.getExpType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setExperimenter
Set the property corresponding toExperimenterCore.getExperimenter()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setExperimenterDataOfChoice
Set the property corresponding toExperimenterCore.getExperimenterDataOfChoice()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVersion
Set the property corresponding toOfHeader.getVersion()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setXid
Set the property corresponding toOfHeader.getXid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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
A newExperimenterMessage
instance.- Returns:
- A new
ExperimenterMessage
instance.
-