Class MultipartReplyMessageBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessageBuilder
Class that builds
MultipartReplyMessage
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:
MultipartReplyMessage createMultipartReplyMessage(int fooXyzzy, int barBaz) {
return new MultipartReplyMessageBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of MultipartReplyMessage, 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 specifiedMultipartReply
.Construct a builder initialized with state from specifiedMultipartReplyMessage
.Construct a new builder initialized from specifiedOfHeader
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<MultipartReplyMessage> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<MultipartReplyMessage>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull MultipartReplyMessage
build()
A newMultipartReplyMessage
instance.void
fieldsFrom
(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.getFlags()
Return current value associated with the property corresponding toMultipartReply.getFlags()
.Return current value associated with the property corresponding toMultipartReply.getMultipartReplyBody()
.getType()
Return current value associated with the property corresponding toMultipartReply.getType()
.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.binding.Augmentation<MultipartReplyMessage>> augmentationType) Remove an augmentation from this builder's product.setFlags
(MultipartRequestFlags value) Set the property corresponding toMultipartReply.getFlags()
to the specified value.Set the property corresponding toMultipartReply.getMultipartReplyBody()
to the specified value.setType
(MultipartType value) Set the property corresponding toMultipartReply.getType()
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
-
MultipartReplyMessageBuilder
public MultipartReplyMessageBuilder()Construct an empty builder. -
MultipartReplyMessageBuilder
Construct a new builder initialized from specifiedMultipartReply
.- Parameters:
arg
- MultipartReply from which the builder should be initialized
-
MultipartReplyMessageBuilder
Construct a new builder initialized from specifiedOfHeader
.- Parameters:
arg
- OfHeader from which the builder should be initialized
-
MultipartReplyMessageBuilder
Construct a builder initialized with state from specifiedMultipartReplyMessage
.- Parameters:
base
- MultipartReplyMessage from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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
-
getFlags
Return current value associated with the property corresponding toMultipartReply.getFlags()
.- Returns:
- current value
-
getMultipartReplyBody
Return current value associated with the property corresponding toMultipartReply.getMultipartReplyBody()
.- Returns:
- current value
-
getType
Return current value associated with the property corresponding toMultipartReply.getType()
.- 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.binding.Augmentation<MultipartReplyMessage>> 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
-
setFlags
Set the property corresponding toMultipartReply.getFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMultipartReplyBody
Set the property corresponding toMultipartReply.getMultipartReplyBody()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setType
Set the property corresponding toMultipartReply.getType()
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 MultipartReplyMessageBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<MultipartReplyMessage> 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 MultipartReplyMessageBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<MultipartReplyMessage>> 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 newMultipartReplyMessage
instance.- Returns:
- A new
MultipartReplyMessage
instance.
-