Class AddFlowInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowInputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<AddFlowInput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<AddFlowInput,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class AddFlowInputBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<AddFlowInput>
Class that buildsAddFlowInput
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:
AddFlowInput createAddFlowInput(int fooXyzzy, int barBaz) { return new AddFlowInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AddFlowInput, 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:
AddFlowInput
,Builder
-
-
Constructor Summary
Constructors Constructor Description AddFlowInputBuilder()
AddFlowInputBuilder(AddFlowInput base)
AddFlowInputBuilder(NodeFlow arg)
AddFlowInputBuilder(TransactionMetadata arg)
AddFlowInputBuilder(Flow arg)
AddFlowInputBuilder(GenericFlowAttributes arg)
AddFlowInputBuilder(NodeContextRef arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AddFlowInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AddFlowInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AddFlowInput>>
E$$augmentation(Class<E$$> augmentationType)
AddFlowInput
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()
String
getFlowName()
FlowRef
getFlowRef()
FlowTableRef
getFlowTable()
org.opendaylight.yangtools.yang.common.Uint16
getHardTimeout()
org.opendaylight.yangtools.yang.common.Uint16
getIdleTimeout()
Boolean
getInstallHw()
Instructions
getInstructions()
Match
getMatch()
NodeRef
getNode()
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()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri
getTransactionUri()
AddFlowInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AddFlowInput>> augmentationType)
Remove an augmentation from this builder's product.AddFlowInputBuilder
setBarrier(Boolean value)
AddFlowInputBuilder
setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
AddFlowInputBuilder
setContainerName(String value)
AddFlowInputBuilder
setCookie(FlowCookie value)
AddFlowInputBuilder
setCookieMask(FlowCookie value)
AddFlowInputBuilder
setFlags(FlowModFlags value)
AddFlowInputBuilder
setFlowName(String value)
AddFlowInputBuilder
setFlowRef(FlowRef value)
AddFlowInputBuilder
setFlowTable(FlowTableRef value)
AddFlowInputBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
AddFlowInputBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
AddFlowInputBuilder
setInstallHw(Boolean value)
AddFlowInputBuilder
setInstructions(Instructions value)
AddFlowInputBuilder
setMatch(Match value)
AddFlowInputBuilder
setNode(NodeRef value)
AddFlowInputBuilder
setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
AddFlowInputBuilder
setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
AddFlowInputBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
AddFlowInputBuilder
setStrict(Boolean value)
AddFlowInputBuilder
setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
AddFlowInputBuilder
setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
-
-
-
Constructor Detail
-
AddFlowInputBuilder
public AddFlowInputBuilder()
-
AddFlowInputBuilder
public AddFlowInputBuilder(TransactionMetadata arg)
-
AddFlowInputBuilder
public AddFlowInputBuilder(NodeFlow arg)
-
AddFlowInputBuilder
public AddFlowInputBuilder(NodeContextRef arg)
-
AddFlowInputBuilder
public AddFlowInputBuilder(Flow arg)
-
AddFlowInputBuilder
public AddFlowInputBuilder(GenericFlowAttributes arg)
-
AddFlowInputBuilder
public AddFlowInputBuilder(AddFlowInput 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:- TransactionMetadata
- Flow
- GenericFlowAttributes
- NodeContextRef
- NodeFlow
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
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()
-
getFlowName
public String getFlowName()
-
getFlowRef
public FlowRef getFlowRef()
-
getFlowTable
public FlowTableRef getFlowTable()
-
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()
-
getNode
public NodeRef getNode()
-
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()
-
getTransactionUri
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri getTransactionUri()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AddFlowInput>> E$$ augmentation(Class<E$$> augmentationType)
-
setBarrier
public AddFlowInputBuilder setBarrier(Boolean value)
-
setBufferId
public AddFlowInputBuilder setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setContainerName
public AddFlowInputBuilder setContainerName(String value)
-
setCookie
public AddFlowInputBuilder setCookie(FlowCookie value)
-
setCookieMask
public AddFlowInputBuilder setCookieMask(FlowCookie value)
-
setFlags
public AddFlowInputBuilder setFlags(FlowModFlags value)
-
setFlowName
public AddFlowInputBuilder setFlowName(String value)
-
setFlowRef
public AddFlowInputBuilder setFlowRef(FlowRef value)
-
setFlowTable
public AddFlowInputBuilder setFlowTable(FlowTableRef value)
-
setHardTimeout
public AddFlowInputBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setIdleTimeout
public AddFlowInputBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setInstallHw
public AddFlowInputBuilder setInstallHw(Boolean value)
-
setInstructions
public AddFlowInputBuilder setInstructions(Instructions value)
-
setMatch
public AddFlowInputBuilder setMatch(Match value)
-
setNode
public AddFlowInputBuilder setNode(NodeRef value)
-
setOutGroup
public AddFlowInputBuilder setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setOutPort
public AddFlowInputBuilder setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setPriority
public AddFlowInputBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setStrict
public AddFlowInputBuilder setStrict(Boolean value)
-
setTableId
public AddFlowInputBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setTransactionUri
public AddFlowInputBuilder setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
-
addAugmentation
public AddFlowInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AddFlowInput> 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 AddFlowInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AddFlowInput>> 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 AddFlowInput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<AddFlowInput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<AddFlowInput,IllegalArgumentException>
-
-