Class MultipartReplyBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.multipart.types.rev170112.MultipartReplyBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MultipartReply>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MultipartReply,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class MultipartReplyBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<MultipartReply>
Class that buildsMultipartReplyBuilder
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:
MultipartReplyBuilder createTarget(int fooXyzzy, int barBaz) { return new MultipartReplyBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MultipartReplyBuilder, 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:
MultipartReplyBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MultipartReplyBuilder()
MultipartReplyBuilder(MultipartHeader arg)
MultipartReplyBuilder(MultipartReply base)
MultipartReplyBuilder(OfHeader arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MultipartReplyBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReply> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReply>>
E$$augmentation(Class<E$$> augmentationType)
MultipartReply
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.MultipartReplyBody
getMultipartReplyBody()
Boolean
getRequestMore()
org.opendaylight.yangtools.yang.common.Uint8
getVersion()
org.opendaylight.yangtools.yang.common.Uint32
getXid()
Boolean
isRequestMore()
Deprecated, for removal: This API element is subject to removal in a future version.MultipartReplyBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReply>> augmentationType)
Remove an augmentation from this builder's product.MultipartReplyBuilder
setMultipartReplyBody(MultipartReplyBody value)
MultipartReplyBuilder
setRequestMore(Boolean value)
MultipartReplyBuilder
setVersion(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVersion(Uint8)
instead.MultipartReplyBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
MultipartReplyBuilder
setXid(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetXid(Uint32)
instead.MultipartReplyBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
MultipartReplyBuilder
public MultipartReplyBuilder()
-
MultipartReplyBuilder
public MultipartReplyBuilder(MultipartHeader arg)
-
MultipartReplyBuilder
public MultipartReplyBuilder(OfHeader arg)
-
MultipartReplyBuilder
public MultipartReplyBuilder(MultipartReply 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.multipart.types.rev170112.MultipartHeader
- 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 or has property with incompatible value
-
getMultipartReplyBody
public MultipartReplyBody getMultipartReplyBody()
-
getRequestMore
public Boolean getRequestMore()
-
isRequestMore
@Deprecated(forRemoval=true) public final Boolean isRequestMore()
Deprecated, for removal: This API element is subject to removal in a future version.
-
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<MultipartReply>> E$$ augmentation(Class<E$$> augmentationType)
-
setMultipartReplyBody
public MultipartReplyBuilder setMultipartReplyBody(MultipartReplyBody value)
-
setRequestMore
public MultipartReplyBuilder setRequestMore(Boolean value)
-
setVersion
public MultipartReplyBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setVersion
@Deprecated(forRemoval=true) public MultipartReplyBuilder setVersion(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVersion(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setXid
public MultipartReplyBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setXid
@Deprecated(forRemoval=true) public MultipartReplyBuilder setXid(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetXid(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public MultipartReplyBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReply> 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 MultipartReplyBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReply>> 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 MultipartReply build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MultipartReply>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MultipartReply,IllegalArgumentException>
-
-