Class MultipartRequestFlowBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.flow._case.MultipartRequestFlowBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MultipartRequestFlow>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MultipartRequestFlow,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class MultipartRequestFlowBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<MultipartRequestFlow>
Class that buildsMultipartRequestFlowBuilder
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:
MultipartRequestFlowBuilder createTarget(int fooXyzzy, int barBaz) { return new MultipartRequestFlowBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MultipartRequestFlowBuilder, 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:
MultipartRequestFlowBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MultipartRequestFlowBuilder()
MultipartRequestFlowBuilder(MatchGrouping arg)
MultipartRequestFlowBuilder(MatchV10Grouping arg)
MultipartRequestFlowBuilder(MultipartRequestFlow base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MultipartRequestFlowBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestFlow> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestFlow>>
E$$augmentation(Class<E$$> augmentationType)
MultipartRequestFlow
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint64
getCookie()
org.opendaylight.yangtools.yang.common.Uint64
getCookieMask()
Match
getMatch()
MatchV10
getMatchV10()
org.opendaylight.yangtools.yang.common.Uint32
getOutGroup()
org.opendaylight.yangtools.yang.common.Uint32
getOutPort()
org.opendaylight.yangtools.yang.common.Uint8
getTableId()
MultipartRequestFlowBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestFlow>> augmentationType)
Remove an augmentation from this builder's product.MultipartRequestFlowBuilder
setCookie(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetCookie(Uint64)
instead.MultipartRequestFlowBuilder
setCookie(org.opendaylight.yangtools.yang.common.Uint64 value)
MultipartRequestFlowBuilder
setCookieMask(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetCookieMask(Uint64)
instead.MultipartRequestFlowBuilder
setCookieMask(org.opendaylight.yangtools.yang.common.Uint64 value)
MultipartRequestFlowBuilder
setMatch(Match value)
MultipartRequestFlowBuilder
setMatchV10(MatchV10 value)
MultipartRequestFlowBuilder
setOutGroup(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOutGroup(Uint32)
instead.MultipartRequestFlowBuilder
setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
MultipartRequestFlowBuilder
setOutPort(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOutPort(Uint32)
instead.MultipartRequestFlowBuilder
setOutPort(org.opendaylight.yangtools.yang.common.Uint32 value)
MultipartRequestFlowBuilder
setTableId(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTableId(Uint8)
instead.MultipartRequestFlowBuilder
setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
MultipartRequestFlowBuilder
public MultipartRequestFlowBuilder()
-
MultipartRequestFlowBuilder
public MultipartRequestFlowBuilder(MatchGrouping arg)
-
MultipartRequestFlowBuilder
public MultipartRequestFlowBuilder(MatchV10Grouping arg)
-
MultipartRequestFlowBuilder
public MultipartRequestFlowBuilder(MultipartRequestFlow 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.oxm.rev150225.MatchV10Grouping
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.MatchGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getCookie
public org.opendaylight.yangtools.yang.common.Uint64 getCookie()
-
getCookieMask
public org.opendaylight.yangtools.yang.common.Uint64 getCookieMask()
-
getMatch
public Match getMatch()
-
getMatchV10
public MatchV10 getMatchV10()
-
getOutGroup
public org.opendaylight.yangtools.yang.common.Uint32 getOutGroup()
-
getOutPort
public org.opendaylight.yangtools.yang.common.Uint32 getOutPort()
-
getTableId
public org.opendaylight.yangtools.yang.common.Uint8 getTableId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestFlow>> E$$ augmentation(Class<E$$> augmentationType)
-
setCookie
public MultipartRequestFlowBuilder setCookie(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setCookie
@Deprecated(forRemoval=true) public MultipartRequestFlowBuilder setCookie(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetCookie(Uint64)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setCookieMask
public MultipartRequestFlowBuilder setCookieMask(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setCookieMask
@Deprecated(forRemoval=true) public MultipartRequestFlowBuilder setCookieMask(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetCookieMask(Uint64)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setMatch
public MultipartRequestFlowBuilder setMatch(Match value)
-
setMatchV10
public MultipartRequestFlowBuilder setMatchV10(MatchV10 value)
-
setOutGroup
public MultipartRequestFlowBuilder setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setOutGroup
@Deprecated(forRemoval=true) public MultipartRequestFlowBuilder setOutGroup(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOutGroup(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setOutPort
public MultipartRequestFlowBuilder setOutPort(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setOutPort
@Deprecated(forRemoval=true) public MultipartRequestFlowBuilder setOutPort(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOutPort(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setTableId
public MultipartRequestFlowBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setTableId
@Deprecated(forRemoval=true) public MultipartRequestFlowBuilder setTableId(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTableId(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public MultipartRequestFlowBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestFlow> 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 MultipartRequestFlowBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestFlow>> 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 MultipartRequestFlow build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MultipartRequestFlow>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MultipartRequestFlow,IllegalArgumentException>
-
-