Class MultipartRequestInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartRequestInputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MultipartRequestInput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MultipartRequestInput,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class MultipartRequestInputBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<MultipartRequestInput>
Class that buildsMultipartRequestInputBuilder
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:
MultipartRequestInputBuilder createTarget(int fooXyzzy, int barBaz) { return new MultipartRequestInputBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MultipartRequestInputBuilder, 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:
MultipartRequestInputBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MultipartRequestInputBuilder()
MultipartRequestInputBuilder(MultipartRequest arg)
MultipartRequestInputBuilder(MultipartRequestInput base)
MultipartRequestInputBuilder(OfHeader arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MultipartRequestInputBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestInput> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.MultipartRequestInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestInput>>
E$$augmentation(Class<E$$> augmentationType)
MultipartRequestInput
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.MultipartRequestFlags
getFlags()
MultipartRequestBody
getMultipartRequestBody()
MultipartType
getType()
org.opendaylight.yangtools.yang.common.Uint8
getVersion()
org.opendaylight.yangtools.yang.common.Uint32
getXid()
MultipartRequestInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestInput>> augmentationType)
Remove an augmentation from this builder's product.MultipartRequestInputBuilder
setFlags(MultipartRequestFlags value)
MultipartRequestInputBuilder
setMultipartRequestBody(MultipartRequestBody value)
MultipartRequestInputBuilder
setType(MultipartType value)
MultipartRequestInputBuilder
setVersion(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVersion(Uint8)
instead.MultipartRequestInputBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
MultipartRequestInputBuilder
setXid(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetXid(Uint32)
instead.MultipartRequestInputBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
MultipartRequestInputBuilder
public MultipartRequestInputBuilder()
-
MultipartRequestInputBuilder
public MultipartRequestInputBuilder(MultipartRequest arg)
-
MultipartRequestInputBuilder
public MultipartRequestInputBuilder(OfHeader arg)
-
MultipartRequestInputBuilder
public MultipartRequestInputBuilder(MultipartRequestInput 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.MultipartRequest
- 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()
-
getMultipartRequestBody
public MultipartRequestBody getMultipartRequestBody()
-
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<MultipartRequestInput>> E$$ augmentation(Class<E$$> augmentationType)
-
setFlags
public MultipartRequestInputBuilder setFlags(MultipartRequestFlags value)
-
setMultipartRequestBody
public MultipartRequestInputBuilder setMultipartRequestBody(MultipartRequestBody value)
-
setType
public MultipartRequestInputBuilder setType(MultipartType value)
-
setVersion
public MultipartRequestInputBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setVersion
@Deprecated(forRemoval=true) public MultipartRequestInputBuilder 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 MultipartRequestInputBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setXid
@Deprecated(forRemoval=true) public MultipartRequestInputBuilder 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 MultipartRequestInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestInput> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public MultipartRequestInputBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestInput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestInput> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public MultipartRequestInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestInput>> 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 MultipartRequestInput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MultipartRequestInput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MultipartRequestInput,IllegalArgumentException>
-
-