Class FlowMessageBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowMessageBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FlowMessage>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FlowMessage,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class FlowMessageBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlowMessage>
Class that buildsFlowMessage
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:
FlowMessage createFlowMessage(int fooXyzzy, int barBaz) { return new FlowMessageBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlowMessage, 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:
FlowMessage
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlowMessageBuilder()
FlowMessageBuilder(Flow arg)
FlowMessageBuilder(FlowMessage base)
FlowMessageBuilder(GenericFlowAttributes arg)
FlowMessageBuilder(OfHeader arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FlowMessageBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowMessage> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowMessage>>
E$$augmentation(Class<E$$> augmentationType)
FlowMessage
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()
FlowModCommand
getCommand()
String
getContainerName()
FlowCookie
getCookie()
FlowCookie
getCookieMask()
FlowModFlags
getFlags()
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()
org.opendaylight.yangtools.yang.common.Uint8
getVersion()
org.opendaylight.yangtools.yang.common.Uint32
getXid()
FlowMessageBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowMessage>> augmentationType)
Remove an augmentation from this builder's product.FlowMessageBuilder
setBarrier(Boolean value)
FlowMessageBuilder
setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowMessageBuilder
setCommand(FlowModCommand value)
FlowMessageBuilder
setContainerName(String value)
FlowMessageBuilder
setCookie(FlowCookie value)
FlowMessageBuilder
setCookieMask(FlowCookie value)
FlowMessageBuilder
setFlags(FlowModFlags value)
FlowMessageBuilder
setFlowName(String value)
FlowMessageBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowMessageBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowMessageBuilder
setInstallHw(Boolean value)
FlowMessageBuilder
setInstructions(Instructions value)
FlowMessageBuilder
setMatch(Match value)
FlowMessageBuilder
setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowMessageBuilder
setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
FlowMessageBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowMessageBuilder
setStrict(Boolean value)
FlowMessageBuilder
setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
FlowMessageBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
FlowMessageBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
FlowMessageBuilder
public FlowMessageBuilder()
-
FlowMessageBuilder
public FlowMessageBuilder(Flow arg)
-
FlowMessageBuilder
public FlowMessageBuilder(GenericFlowAttributes arg)
-
FlowMessageBuilder
public FlowMessageBuilder(OfHeader arg)
-
FlowMessageBuilder
public FlowMessageBuilder(FlowMessage 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
- GenericFlowAttributes
- OfHeader
- 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()
-
getCommand
public FlowModCommand getCommand()
-
getContainerName
public String getContainerName()
-
getCookie
public FlowCookie getCookie()
-
getCookieMask
public FlowCookie getCookieMask()
-
getFlags
public FlowModFlags getFlags()
-
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()
-
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<FlowMessage>> E$$ augmentation(Class<E$$> augmentationType)
-
setBarrier
public FlowMessageBuilder setBarrier(Boolean value)
-
setBufferId
public FlowMessageBuilder setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setCommand
public FlowMessageBuilder setCommand(FlowModCommand value)
-
setContainerName
public FlowMessageBuilder setContainerName(String value)
-
setCookie
public FlowMessageBuilder setCookie(FlowCookie value)
-
setCookieMask
public FlowMessageBuilder setCookieMask(FlowCookie value)
-
setFlags
public FlowMessageBuilder setFlags(FlowModFlags value)
-
setFlowName
public FlowMessageBuilder setFlowName(String value)
-
setHardTimeout
public FlowMessageBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setIdleTimeout
public FlowMessageBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setInstallHw
public FlowMessageBuilder setInstallHw(Boolean value)
-
setInstructions
public FlowMessageBuilder setInstructions(Instructions value)
-
setMatch
public FlowMessageBuilder setMatch(Match value)
-
setOutGroup
public FlowMessageBuilder setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setOutPort
public FlowMessageBuilder setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setPriority
public FlowMessageBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setStrict
public FlowMessageBuilder setStrict(Boolean value)
-
setTableId
public FlowMessageBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setVersion
public FlowMessageBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setXid
public FlowMessageBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
addAugmentation
public FlowMessageBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowMessage> 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 FlowMessageBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowMessage>> 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 FlowMessage build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FlowMessage>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FlowMessage,IllegalArgumentException>
-
-