Package org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.remove.flows.batch.input
Class BatchRemoveFlowsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.remove.flows.batch.input.BatchRemoveFlowsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BatchRemoveFlows>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BatchRemoveFlows,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class BatchRemoveFlowsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BatchRemoveFlows>
Class that buildsBatchRemoveFlows
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:
BatchRemoveFlows createBatchRemoveFlows(int fooXyzzy, int barBaz) { return new BatchRemoveFlowsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BatchRemoveFlows, 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:
BatchRemoveFlows
,Builder
-
-
Constructor Summary
Constructors Constructor Description BatchRemoveFlowsBuilder()
BatchRemoveFlowsBuilder(Flow arg)
BatchRemoveFlowsBuilder(GenericFlowAttributes arg)
BatchRemoveFlowsBuilder(BatchFlowIdGrouping arg)
BatchRemoveFlowsBuilder(BatchFlowInputGrouping arg)
BatchRemoveFlowsBuilder(BatchRemoveFlows base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BatchRemoveFlowsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveFlows> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveFlows>>
E$$augmentation(Class<E$$> augmentationType)
BatchRemoveFlows
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getBarrier()
org.opendaylight.yangtools.yang.common.Uint32
getBufferId()
String
getContainerName()
FlowCookie
getCookie()
FlowCookie
getCookieMask()
FlowModFlags
getFlags()
FlowId
getFlowId()
String
getFlowName()
org.opendaylight.yangtools.yang.common.Uint16
getHardTimeout()
org.opendaylight.yangtools.yang.common.Uint16
getIdleTimeout()
Boolean
getInstallHw()
Instructions
getInstructions()
Match
getMatch()
org.opendaylight.yangtools.yang.common.Uint32
getOutGroup()
org.opendaylight.yangtools.yang.common.Uint64
getOutPort()
org.opendaylight.yangtools.yang.common.Uint16
getPriority()
Boolean
getStrict()
org.opendaylight.yangtools.yang.common.Uint8
getTableId()
BatchRemoveFlowsKey
key()
BatchRemoveFlowsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveFlows>> augmentationType)
Remove an augmentation from this builder's product.BatchRemoveFlowsBuilder
setBarrier(Boolean value)
BatchRemoveFlowsBuilder
setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
BatchRemoveFlowsBuilder
setContainerName(String value)
BatchRemoveFlowsBuilder
setCookie(FlowCookie value)
BatchRemoveFlowsBuilder
setCookieMask(FlowCookie value)
BatchRemoveFlowsBuilder
setFlags(FlowModFlags value)
BatchRemoveFlowsBuilder
setFlowId(FlowId value)
BatchRemoveFlowsBuilder
setFlowName(String value)
BatchRemoveFlowsBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
BatchRemoveFlowsBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
BatchRemoveFlowsBuilder
setInstallHw(Boolean value)
BatchRemoveFlowsBuilder
setInstructions(Instructions value)
BatchRemoveFlowsBuilder
setMatch(Match value)
BatchRemoveFlowsBuilder
setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
BatchRemoveFlowsBuilder
setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
BatchRemoveFlowsBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
BatchRemoveFlowsBuilder
setStrict(Boolean value)
BatchRemoveFlowsBuilder
setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
BatchRemoveFlowsBuilder
withKey(BatchRemoveFlowsKey key)
-
-
-
Constructor Detail
-
BatchRemoveFlowsBuilder
public BatchRemoveFlowsBuilder()
-
BatchRemoveFlowsBuilder
public BatchRemoveFlowsBuilder(BatchFlowInputGrouping arg)
-
BatchRemoveFlowsBuilder
public BatchRemoveFlowsBuilder(BatchFlowIdGrouping arg)
-
BatchRemoveFlowsBuilder
public BatchRemoveFlowsBuilder(Flow arg)
-
BatchRemoveFlowsBuilder
public BatchRemoveFlowsBuilder(GenericFlowAttributes arg)
-
BatchRemoveFlowsBuilder
public BatchRemoveFlowsBuilder(BatchRemoveFlows 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:- Flow
- BatchFlowInputGrouping
- GenericFlowAttributes
- BatchFlowIdGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public BatchRemoveFlowsKey key()
-
getBarrier
public Boolean getBarrier()
-
getBufferId
public org.opendaylight.yangtools.yang.common.Uint32 getBufferId()
-
getContainerName
public String getContainerName()
-
getCookie
public FlowCookie getCookie()
-
getCookieMask
public FlowCookie getCookieMask()
-
getFlags
public FlowModFlags getFlags()
-
getFlowId
public FlowId getFlowId()
-
getFlowName
public String getFlowName()
-
getHardTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getHardTimeout()
-
getIdleTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getIdleTimeout()
-
getInstallHw
public Boolean getInstallHw()
-
getInstructions
public Instructions getInstructions()
-
getMatch
public Match getMatch()
-
getOutGroup
public org.opendaylight.yangtools.yang.common.Uint32 getOutGroup()
-
getOutPort
public org.opendaylight.yangtools.yang.common.Uint64 getOutPort()
-
getPriority
public org.opendaylight.yangtools.yang.common.Uint16 getPriority()
-
getStrict
public Boolean getStrict()
-
getTableId
public org.opendaylight.yangtools.yang.common.Uint8 getTableId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveFlows>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public BatchRemoveFlowsBuilder withKey(BatchRemoveFlowsKey key)
-
setBarrier
public BatchRemoveFlowsBuilder setBarrier(Boolean value)
-
setBufferId
public BatchRemoveFlowsBuilder setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setContainerName
public BatchRemoveFlowsBuilder setContainerName(String value)
-
setCookie
public BatchRemoveFlowsBuilder setCookie(FlowCookie value)
-
setCookieMask
public BatchRemoveFlowsBuilder setCookieMask(FlowCookie value)
-
setFlags
public BatchRemoveFlowsBuilder setFlags(FlowModFlags value)
-
setFlowId
public BatchRemoveFlowsBuilder setFlowId(FlowId value)
-
setFlowName
public BatchRemoveFlowsBuilder setFlowName(String value)
-
setHardTimeout
public BatchRemoveFlowsBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setIdleTimeout
public BatchRemoveFlowsBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setInstallHw
public BatchRemoveFlowsBuilder setInstallHw(Boolean value)
-
setInstructions
public BatchRemoveFlowsBuilder setInstructions(Instructions value)
-
setMatch
public BatchRemoveFlowsBuilder setMatch(Match value)
-
setOutGroup
public BatchRemoveFlowsBuilder setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setOutPort
public BatchRemoveFlowsBuilder setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setPriority
public BatchRemoveFlowsBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setStrict
public BatchRemoveFlowsBuilder setStrict(Boolean value)
-
setTableId
public BatchRemoveFlowsBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
addAugmentation
public BatchRemoveFlowsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveFlows> 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 BatchRemoveFlowsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveFlows>> 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 BatchRemoveFlows build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BatchRemoveFlows>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BatchRemoveFlows,IllegalArgumentException>
-
-