Class FlowModCaseDataBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.bundle.add.message.grouping.bundle.inner.message.bundle.flow.mod._case.FlowModCaseDataBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FlowModCaseData>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FlowModCaseData,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class FlowModCaseDataBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlowModCaseData>
Class that buildsFlowModCaseDataBuilder
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:
FlowModCaseDataBuilder createTarget(int fooXyzzy, int barBaz) { return new FlowModCaseDataBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlowModCaseDataBuilder, 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:
FlowModCaseDataBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlowModCaseDataBuilder()
FlowModCaseDataBuilder(ActionsGrouping arg)
FlowModCaseDataBuilder(InstructionsGrouping arg)
FlowModCaseDataBuilder(MatchGrouping arg)
FlowModCaseDataBuilder(MatchV10Grouping arg)
FlowModCaseDataBuilder(FlowMod arg)
FlowModCaseDataBuilder(OfHeader arg)
FlowModCaseDataBuilder(FlowModCaseData base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FlowModCaseDataBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCaseData>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCaseData> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCaseData>>
E$$augmentation(Class<E$$> augmentationType)
FlowModCaseData
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<Action>
getAction()
org.opendaylight.yangtools.yang.common.Uint32
getBufferId()
FlowModCommand
getCommand()
org.opendaylight.yangtools.yang.common.Uint64
getCookie()
org.opendaylight.yangtools.yang.common.Uint64
getCookieMask()
FlowModFlags
getFlags()
FlowModFlagsV10
getFlagsV10()
org.opendaylight.yangtools.yang.common.Uint16
getHardTimeout()
org.opendaylight.yangtools.yang.common.Uint16
getIdleTimeout()
List<Instruction>
getInstruction()
Match
getMatch()
MatchV10
getMatchV10()
org.opendaylight.yangtools.yang.common.Uint32
getOutGroup()
PortNumber
getOutPort()
org.opendaylight.yangtools.yang.common.Uint16
getPriority()
TableId
getTableId()
org.opendaylight.yangtools.yang.common.Uint8
getVersion()
org.opendaylight.yangtools.yang.common.Uint32
getXid()
FlowModCaseDataBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCaseData>> augmentationType)
FlowModCaseDataBuilder
setAction(List<Action> values)
FlowModCaseDataBuilder
setBufferId(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setBufferId(Uint32)} instead.FlowModCaseDataBuilder
setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowModCaseDataBuilder
setCommand(FlowModCommand value)
FlowModCaseDataBuilder
setCookie(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setCookie(Uint64)} instead.FlowModCaseDataBuilder
setCookie(org.opendaylight.yangtools.yang.common.Uint64 value)
FlowModCaseDataBuilder
setCookieMask(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setCookieMask(Uint64)} instead.FlowModCaseDataBuilder
setCookieMask(org.opendaylight.yangtools.yang.common.Uint64 value)
FlowModCaseDataBuilder
setFlags(FlowModFlags value)
FlowModCaseDataBuilder
setFlagsV10(FlowModFlagsV10 value)
FlowModCaseDataBuilder
setHardTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setHardTimeout(Uint16)} instead.FlowModCaseDataBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowModCaseDataBuilder
setIdleTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setIdleTimeout(Uint16)} instead.FlowModCaseDataBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowModCaseDataBuilder
setInstruction(List<Instruction> values)
FlowModCaseDataBuilder
setMatch(Match value)
FlowModCaseDataBuilder
setMatchV10(MatchV10 value)
FlowModCaseDataBuilder
setOutGroup(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setOutGroup(Uint32)} instead.FlowModCaseDataBuilder
setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowModCaseDataBuilder
setOutPort(PortNumber value)
FlowModCaseDataBuilder
setPriority(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setPriority(Uint16)} instead.FlowModCaseDataBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowModCaseDataBuilder
setTableId(TableId value)
FlowModCaseDataBuilder
setVersion(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setVersion(Uint8)} instead.FlowModCaseDataBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
FlowModCaseDataBuilder
setXid(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setXid(Uint32)} instead.FlowModCaseDataBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
FlowModCaseDataBuilder
public FlowModCaseDataBuilder()
-
FlowModCaseDataBuilder
public FlowModCaseDataBuilder(FlowMod arg)
-
FlowModCaseDataBuilder
public FlowModCaseDataBuilder(OfHeader arg)
-
FlowModCaseDataBuilder
public FlowModCaseDataBuilder(MatchGrouping arg)
-
FlowModCaseDataBuilder
public FlowModCaseDataBuilder(InstructionsGrouping arg)
-
FlowModCaseDataBuilder
public FlowModCaseDataBuilder(MatchV10Grouping arg)
-
FlowModCaseDataBuilder
public FlowModCaseDataBuilder(ActionsGrouping arg)
-
FlowModCaseDataBuilder
public FlowModCaseDataBuilder(FlowModCaseData 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
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.ActionsGrouping
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.InstructionsGrouping
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowMod
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getBufferId
public org.opendaylight.yangtools.yang.common.Uint32 getBufferId()
-
getCommand
public FlowModCommand getCommand()
-
getCookie
public org.opendaylight.yangtools.yang.common.Uint64 getCookie()
-
getCookieMask
public org.opendaylight.yangtools.yang.common.Uint64 getCookieMask()
-
getFlags
public FlowModFlags getFlags()
-
getFlagsV10
public FlowModFlagsV10 getFlagsV10()
-
getHardTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getHardTimeout()
-
getIdleTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getIdleTimeout()
-
getInstruction
public List<Instruction> getInstruction()
-
getMatch
public Match getMatch()
-
getMatchV10
public MatchV10 getMatchV10()
-
getOutGroup
public org.opendaylight.yangtools.yang.common.Uint32 getOutGroup()
-
getOutPort
public PortNumber getOutPort()
-
getPriority
public org.opendaylight.yangtools.yang.common.Uint16 getPriority()
-
getTableId
public TableId getTableId()
-
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<FlowModCaseData>> E$$ augmentation(Class<E$$> augmentationType)
-
setAction
public FlowModCaseDataBuilder setAction(List<Action> values)
-
setBufferId
public FlowModCaseDataBuilder setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setBufferId
@Deprecated(forRemoval=true) public FlowModCaseDataBuilder setBufferId(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setBufferId(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setCommand
public FlowModCaseDataBuilder setCommand(FlowModCommand value)
-
setCookie
public FlowModCaseDataBuilder setCookie(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setCookie
@Deprecated(forRemoval=true) public FlowModCaseDataBuilder setCookie(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setCookie(Uint64)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setCookieMask
public FlowModCaseDataBuilder setCookieMask(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setCookieMask
@Deprecated(forRemoval=true) public FlowModCaseDataBuilder setCookieMask(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setCookieMask(Uint64)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setFlags
public FlowModCaseDataBuilder setFlags(FlowModFlags value)
-
setFlagsV10
public FlowModCaseDataBuilder setFlagsV10(FlowModFlagsV10 value)
-
setHardTimeout
public FlowModCaseDataBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setHardTimeout
@Deprecated(forRemoval=true) public FlowModCaseDataBuilder setHardTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setHardTimeout(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setIdleTimeout
public FlowModCaseDataBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setIdleTimeout
@Deprecated(forRemoval=true) public FlowModCaseDataBuilder setIdleTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setIdleTimeout(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setInstruction
public FlowModCaseDataBuilder setInstruction(List<Instruction> values)
-
setMatch
public FlowModCaseDataBuilder setMatch(Match value)
-
setMatchV10
public FlowModCaseDataBuilder setMatchV10(MatchV10 value)
-
setOutGroup
public FlowModCaseDataBuilder setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setOutGroup
@Deprecated(forRemoval=true) public FlowModCaseDataBuilder setOutGroup(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setOutGroup(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setOutPort
public FlowModCaseDataBuilder setOutPort(PortNumber value)
-
setPriority
public FlowModCaseDataBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setPriority
@Deprecated(forRemoval=true) public FlowModCaseDataBuilder setPriority(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setPriority(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setTableId
public FlowModCaseDataBuilder setTableId(TableId value)
-
setVersion
public FlowModCaseDataBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setVersion
@Deprecated(forRemoval=true) public FlowModCaseDataBuilder 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 FlowModCaseDataBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setXid
@Deprecated(forRemoval=true) public FlowModCaseDataBuilder 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 FlowModCaseDataBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCaseData>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCaseData> augmentationValue)
-
removeAugmentation
public FlowModCaseDataBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCaseData>> augmentationType)
-
build
public FlowModCaseData build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FlowModCaseData>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FlowModCaseData,IllegalArgumentException>
-
-