Class MultipartReplyMessageBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessageBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MultipartReplyMessage>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MultipartReplyMessage,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class MultipartReplyMessageBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<MultipartReplyMessage>
Class that buildsMultipartReplyMessageBuilder
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:
MultipartReplyMessageBuilder createTarget(int fooXyzzy, int barBaz) { return new MultipartReplyMessageBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MultipartReplyMessageBuilder, 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 oportunities, 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:
MultipartReplyMessageBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MultipartReplyMessageBuilder()
MultipartReplyMessageBuilder(MultipartReply arg)
MultipartReplyMessageBuilder(MultipartReplyMessage base)
MultipartReplyMessageBuilder(OfHeader arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MultipartReplyMessageBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyMessage>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyMessage> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyMessage>>
E$$augmentation(Class<E$$> augmentationType)
MultipartReplyMessage
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.MultipartRequestFlags
getFlags()
MultipartReplyBody
getMultipartReplyBody()
MultipartType
getType()
org.opendaylight.yangtools.yang.common.Uint8
getVersion()
org.opendaylight.yangtools.yang.common.Uint32
getXid()
MultipartReplyMessageBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyMessage>> augmentationType)
MultipartReplyMessageBuilder
setFlags(MultipartRequestFlags value)
MultipartReplyMessageBuilder
setMultipartReplyBody(MultipartReplyBody value)
MultipartReplyMessageBuilder
setType(MultipartType value)
MultipartReplyMessageBuilder
setVersion(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setVersion(Uint8)} instead.MultipartReplyMessageBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
MultipartReplyMessageBuilder
setXid(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setXid(Uint32)} instead.MultipartReplyMessageBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
MultipartReplyMessageBuilder
public MultipartReplyMessageBuilder()
-
MultipartReplyMessageBuilder
public MultipartReplyMessageBuilder(MultipartReply arg)
-
MultipartReplyMessageBuilder
public MultipartReplyMessageBuilder(OfHeader arg)
-
MultipartReplyMessageBuilder
public MultipartReplyMessageBuilder(MultipartReplyMessage 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getFlags
public MultipartRequestFlags getFlags()
-
getMultipartReplyBody
public MultipartReplyBody getMultipartReplyBody()
-
getType
public MultipartType getType()
-
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<MultipartReplyMessage>> E$$ augmentation(Class<E$$> augmentationType)
-
setFlags
public MultipartReplyMessageBuilder setFlags(MultipartRequestFlags value)
-
setMultipartReplyBody
public MultipartReplyMessageBuilder setMultipartReplyBody(MultipartReplyBody value)
-
setType
public MultipartReplyMessageBuilder setType(MultipartType value)
-
setVersion
public MultipartReplyMessageBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setVersion
@Deprecated(forRemoval=true) public MultipartReplyMessageBuilder setVersion(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setVersion(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setXid
public MultipartReplyMessageBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setXid
@Deprecated(forRemoval=true) public MultipartReplyMessageBuilder setXid(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setXid(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public MultipartReplyMessageBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyMessage>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyMessage> augmentationValue)
-
removeAugmentation
public MultipartReplyMessageBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyMessage>> augmentationType)
-
build
public MultipartReplyMessage build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MultipartReplyMessage>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MultipartReplyMessage,IllegalArgumentException>
-
-