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
Class that builds
FlowModCaseData
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:
FlowModCaseData createFlowModCaseData(int fooXyzzy, int barBaz) {
return new FlowModCaseDataBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of FlowModCaseData, 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:
-
Constructor Summary
ConstructorsConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedActionsGrouping
.Construct a new builder initialized from specifiedInstructionsGrouping
.Construct a new builder initialized from specifiedMatchGrouping
.Construct a new builder initialized from specifiedMatchV10Grouping
.Construct a new builder initialized from specifiedFlowMod$G
.Construct a new builder initialized from specifiedOfHeader
.Construct a builder initialized with state from specifiedFlowModCaseData
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCaseData> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCaseData>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull FlowModCaseData
build()
A newFlowModCaseData
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toActionsGrouping.getAction()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toFlowMod$G.getBufferId()
.Return current value associated with the property corresponding toFlowMod$G.getCommand()
.org.opendaylight.yangtools.yang.common.Uint64
Return current value associated with the property corresponding toFlowMod$G.getCookie()
.org.opendaylight.yangtools.yang.common.Uint64
Return current value associated with the property corresponding toFlowMod$G.getCookieMask()
.getFlags()
Return current value associated with the property corresponding toFlowMod$G.getFlags()
.Return current value associated with the property corresponding toFlowMod$G.getFlagsV10()
.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toFlowMod$G.getHardTimeout()
.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toFlowMod$G.getIdleTimeout()
.Return current value associated with the property corresponding toInstructionsGrouping.getInstruction()
.getMatch()
Return current value associated with the property corresponding toMatchGrouping.getMatch()
.Return current value associated with the property corresponding toMatchV10Grouping.getMatchV10()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toFlowMod$G.getOutGroup()
.Return current value associated with the property corresponding toFlowMod$G.getOutPort()
.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toFlowMod$G.getPriority()
.Return current value associated with the property corresponding toFlowMod$G.getTableId()
.org.opendaylight.yangtools.yang.common.Uint8
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()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCaseData>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toActionsGrouping.getAction()
to the specified value.setBufferId
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toFlowMod$G.getBufferId()
to the specified value.setCommand
(FlowModCommand value) Set the property corresponding toFlowMod$G.getCommand()
to the specified value.setCookie
(org.opendaylight.yangtools.yang.common.Uint64 value) Set the property corresponding toFlowMod$G.getCookie()
to the specified value.setCookieMask
(org.opendaylight.yangtools.yang.common.Uint64 value) Set the property corresponding toFlowMod$G.getCookieMask()
to the specified value.setFlags
(FlowModFlags value) Set the property corresponding toFlowMod$G.getFlags()
to the specified value.setFlagsV10
(FlowModFlagsV10 value) Set the property corresponding toFlowMod$G.getFlagsV10()
to the specified value.setHardTimeout
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toFlowMod$G.getHardTimeout()
to the specified value.setIdleTimeout
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toFlowMod$G.getIdleTimeout()
to the specified value.setInstruction
(List<Instruction> values) Set the property corresponding toInstructionsGrouping.getInstruction()
to the specified value.Set the property corresponding toMatchGrouping.getMatch()
to the specified value.setMatchV10
(MatchV10 value) Set the property corresponding toMatchV10Grouping.getMatchV10()
to the specified value.setOutGroup
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toFlowMod$G.getOutGroup()
to the specified value.setOutPort
(PortNumber value) Set the property corresponding toFlowMod$G.getOutPort()
to the specified value.setPriority
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toFlowMod$G.getPriority()
to the specified value.setTableId
(TableId value) Set the property corresponding toFlowMod$G.getTableId()
to the specified value.setVersion
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toOfHeader.getVersion()
to the specified value.setXid
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toOfHeader.getXid()
to the specified value.
-
Constructor Details
-
FlowModCaseDataBuilder
public FlowModCaseDataBuilder()Construct an empty builder. -
FlowModCaseDataBuilder
Construct a new builder initialized from specifiedFlowMod$G
.- Parameters:
arg
- FlowMod$G from which the builder should be initialized
-
FlowModCaseDataBuilder
Construct a new builder initialized from specifiedOfHeader
.- Parameters:
arg
- OfHeader from which the builder should be initialized
-
FlowModCaseDataBuilder
Construct a new builder initialized from specifiedMatchGrouping
.- Parameters:
arg
- MatchGrouping from which the builder should be initialized
-
FlowModCaseDataBuilder
Construct a new builder initialized from specifiedInstructionsGrouping
.- Parameters:
arg
- InstructionsGrouping from which the builder should be initialized
-
FlowModCaseDataBuilder
Construct a new builder initialized from specifiedMatchV10Grouping
.- Parameters:
arg
- MatchV10Grouping from which the builder should be initialized
-
FlowModCaseDataBuilder
Construct a new builder initialized from specifiedActionsGrouping
.- Parameters:
arg
- ActionsGrouping from which the builder should be initialized
-
FlowModCaseDataBuilder
Construct a builder initialized with state from specifiedFlowModCaseData
.- Parameters:
base
- FlowModCaseData from which the builder should be initialized
-
-
Method Details
-
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
-
getAction
Return current value associated with the property corresponding toActionsGrouping.getAction()
.- Returns:
- current value
-
getBufferId
public org.opendaylight.yangtools.yang.common.Uint32 getBufferId()Return current value associated with the property corresponding toFlowMod$G.getBufferId()
.- Returns:
- current value
-
getCommand
Return current value associated with the property corresponding toFlowMod$G.getCommand()
.- Returns:
- current value
-
getCookie
public org.opendaylight.yangtools.yang.common.Uint64 getCookie()Return current value associated with the property corresponding toFlowMod$G.getCookie()
.- Returns:
- current value
-
getCookieMask
public org.opendaylight.yangtools.yang.common.Uint64 getCookieMask()Return current value associated with the property corresponding toFlowMod$G.getCookieMask()
.- Returns:
- current value
-
getFlags
Return current value associated with the property corresponding toFlowMod$G.getFlags()
.- Returns:
- current value
-
getFlagsV10
Return current value associated with the property corresponding toFlowMod$G.getFlagsV10()
.- Returns:
- current value
-
getHardTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getHardTimeout()Return current value associated with the property corresponding toFlowMod$G.getHardTimeout()
.- Returns:
- current value
-
getIdleTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getIdleTimeout()Return current value associated with the property corresponding toFlowMod$G.getIdleTimeout()
.- Returns:
- current value
-
getInstruction
Return current value associated with the property corresponding toInstructionsGrouping.getInstruction()
.- Returns:
- current value
-
getMatch
Return current value associated with the property corresponding toMatchGrouping.getMatch()
.- Returns:
- current value
-
getMatchV10
Return current value associated with the property corresponding toMatchV10Grouping.getMatchV10()
.- Returns:
- current value
-
getOutGroup
public org.opendaylight.yangtools.yang.common.Uint32 getOutGroup()Return current value associated with the property corresponding toFlowMod$G.getOutGroup()
.- Returns:
- current value
-
getOutPort
Return current value associated with the property corresponding toFlowMod$G.getOutPort()
.- Returns:
- current value
-
getPriority
public org.opendaylight.yangtools.yang.common.Uint16 getPriority()Return current value associated with the property corresponding toFlowMod$G.getPriority()
.- Returns:
- current value
-
getTableId
Return current value associated with the property corresponding toFlowMod$G.getTableId()
.- 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<FlowModCaseData>> 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
-
setAction
Set the property corresponding toActionsGrouping.getAction()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setBufferId
Set the property corresponding toFlowMod$G.getBufferId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCommand
Set the property corresponding toFlowMod$G.getCommand()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCookie
Set the property corresponding toFlowMod$G.getCookie()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCookieMask
Set the property corresponding toFlowMod$G.getCookieMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlags
Set the property corresponding toFlowMod$G.getFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlagsV10
Set the property corresponding toFlowMod$G.getFlagsV10()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setHardTimeout
Set the property corresponding toFlowMod$G.getHardTimeout()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIdleTimeout
Set the property corresponding toFlowMod$G.getIdleTimeout()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInstruction
Set the property corresponding toInstructionsGrouping.getInstruction()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setMatch
Set the property corresponding toMatchGrouping.getMatch()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMatchV10
Set the property corresponding toMatchV10Grouping.getMatchV10()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOutGroup
Set the property corresponding toFlowMod$G.getOutGroup()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOutPort
Set the property corresponding toFlowMod$G.getOutPort()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPriority
Set the property corresponding toFlowMod$G.getPriority()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTableId
Set the property corresponding toFlowMod$G.getTableId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVersion
Set the property corresponding toOfHeader.getVersion()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setXid
Set the property corresponding toOfHeader.getXid()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public FlowModCaseDataBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCaseData> 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 FlowModCaseDataBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCaseData>> 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
A newFlowModCaseData
instance.- Returns:
- A new
FlowModCaseData
instance.
-