Class MultipartRequestBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.multipart.types.rev170112.MultipartRequestBuilder
-
@Generated("mdsal-binding-generator") public class MultipartRequestBuilder extends Object
Class that buildsMultipartRequest
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:
MultipartRequest createMultipartRequest(int fooXyzzy, int barBaz) { return new MultipartRequestBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MultipartRequest, 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:
MultipartRequest
- 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
-
-
Constructor Summary
Constructors Constructor Description MultipartRequestBuilder()
Construct an empty builder.MultipartRequestBuilder(MultipartHeader arg)
Construct a new builder initialized from specifiedMultipartHeader
.MultipartRequestBuilder(MultipartRequest base)
Construct a builder initialized with state from specifiedMultipartRequest
.MultipartRequestBuilder(OfHeader arg)
Construct a new builder initialized from specifiedOfHeader
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MultipartRequestBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequest> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequest>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull MultipartRequest
build()
A newMultipartRequest
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.MultipartRequestBody
getMultipartRequestBody()
Return current value associated with the property corresponding toMultipartRequest.getMultipartRequestBody()
.Boolean
getRequestMore()
Return current value associated with the property corresponding toMultipartHeader.getRequestMore()
.org.opendaylight.yangtools.yang.common.Uint8
getVersion()
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()
.MultipartRequestBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequest>> augmentationType)
Remove an augmentation from this builder's product.MultipartRequestBuilder
setMultipartRequestBody(MultipartRequestBody value)
Set the property corresponding toMultipartRequest.getMultipartRequestBody()
to the specified value.MultipartRequestBuilder
setRequestMore(Boolean value)
Set the property corresponding toMultipartHeader.getRequestMore()
to the specified value.MultipartRequestBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toOfHeader.getVersion()
to the specified value.MultipartRequestBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toOfHeader.getXid()
to the specified value.
-
-
-
Constructor Detail
-
MultipartRequestBuilder
public MultipartRequestBuilder()
Construct an empty builder.
-
MultipartRequestBuilder
public MultipartRequestBuilder(MultipartHeader arg)
Construct a new builder initialized from specifiedMultipartHeader
.- Parameters:
arg
- MultipartHeader from which the builder should be initialized
-
MultipartRequestBuilder
public MultipartRequestBuilder(OfHeader arg)
Construct a new builder initialized from specifiedOfHeader
.- Parameters:
arg
- OfHeader from which the builder should be initialized
-
MultipartRequestBuilder
public MultipartRequestBuilder(MultipartRequest base)
Construct a builder initialized with state from specifiedMultipartRequest
.- Parameters:
base
- MultipartRequest from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getMultipartRequestBody
public MultipartRequestBody getMultipartRequestBody()
Return current value associated with the property corresponding toMultipartRequest.getMultipartRequestBody()
.- Returns:
- current value
-
getRequestMore
public Boolean getRequestMore()
Return current value associated with the property corresponding toMultipartHeader.getRequestMore()
.- 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<MultipartRequest>> 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
-
setMultipartRequestBody
public MultipartRequestBuilder setMultipartRequestBody(MultipartRequestBody value)
Set the property corresponding toMultipartRequest.getMultipartRequestBody()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRequestMore
public MultipartRequestBuilder setRequestMore(Boolean value)
Set the property corresponding toMultipartHeader.getRequestMore()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVersion
public MultipartRequestBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toOfHeader.getVersion()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setXid
public MultipartRequestBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toOfHeader.getXid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MultipartRequestBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequest> 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 MultipartRequestBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequest>> 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 @NonNull MultipartRequest build()
A newMultipartRequest
instance.- Returns:
- A new
MultipartRequest
instance.
-
-