Class FlowRemovedMessageBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemovedMessageBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FlowRemovedMessage>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FlowRemovedMessage,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class FlowRemovedMessageBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlowRemovedMessage>
Class that buildsFlowRemovedMessage
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:
FlowRemovedMessage createFlowRemovedMessage(int fooXyzzy, int barBaz) { return new FlowRemovedMessageBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlowRemovedMessage, 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:
FlowRemovedMessage
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlowRemovedMessageBuilder()
FlowRemovedMessageBuilder(MatchGrouping arg)
FlowRemovedMessageBuilder(MatchV10Grouping arg)
FlowRemovedMessageBuilder(FlowRemoved arg)
FlowRemovedMessageBuilder(FlowRemovedMessage base)
FlowRemovedMessageBuilder(OfHeader arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FlowRemovedMessageBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowRemovedMessage> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowRemovedMessage>>
E$$augmentation(Class<E$$> augmentationType)
FlowRemovedMessage
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint64
getByteCount()
org.opendaylight.yangtools.yang.common.Uint64
getCookie()
org.opendaylight.yangtools.yang.common.Uint32
getDurationNsec()
org.opendaylight.yangtools.yang.common.Uint32
getDurationSec()
org.opendaylight.yangtools.yang.common.Uint16
getHardTimeout()
org.opendaylight.yangtools.yang.common.Uint16
getIdleTimeout()
Match
getMatch()
MatchV10
getMatchV10()
org.opendaylight.yangtools.yang.common.Uint64
getPacketCount()
org.opendaylight.yangtools.yang.common.Uint16
getPriority()
FlowRemovedReason
getReason()
TableId
getTableId()
org.opendaylight.yangtools.yang.common.Uint8
getVersion()
org.opendaylight.yangtools.yang.common.Uint32
getXid()
FlowRemovedMessageBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowRemovedMessage>> augmentationType)
Remove an augmentation from this builder's product.FlowRemovedMessageBuilder
setByteCount(org.opendaylight.yangtools.yang.common.Uint64 value)
FlowRemovedMessageBuilder
setCookie(org.opendaylight.yangtools.yang.common.Uint64 value)
FlowRemovedMessageBuilder
setDurationNsec(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowRemovedMessageBuilder
setDurationSec(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowRemovedMessageBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowRemovedMessageBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowRemovedMessageBuilder
setMatch(Match value)
FlowRemovedMessageBuilder
setMatchV10(MatchV10 value)
FlowRemovedMessageBuilder
setPacketCount(org.opendaylight.yangtools.yang.common.Uint64 value)
FlowRemovedMessageBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowRemovedMessageBuilder
setReason(FlowRemovedReason value)
FlowRemovedMessageBuilder
setTableId(TableId value)
FlowRemovedMessageBuilder
setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
FlowRemovedMessageBuilder
setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
FlowRemovedMessageBuilder
public FlowRemovedMessageBuilder()
-
FlowRemovedMessageBuilder
public FlowRemovedMessageBuilder(FlowRemoved arg)
-
FlowRemovedMessageBuilder
public FlowRemovedMessageBuilder(OfHeader arg)
-
FlowRemovedMessageBuilder
public FlowRemovedMessageBuilder(MatchGrouping arg)
-
FlowRemovedMessageBuilder
public FlowRemovedMessageBuilder(MatchV10Grouping arg)
-
FlowRemovedMessageBuilder
public FlowRemovedMessageBuilder(FlowRemovedMessage 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:- MatchV10Grouping
- FlowRemoved
- MatchGrouping
- OfHeader
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getByteCount
public org.opendaylight.yangtools.yang.common.Uint64 getByteCount()
-
getCookie
public org.opendaylight.yangtools.yang.common.Uint64 getCookie()
-
getDurationNsec
public org.opendaylight.yangtools.yang.common.Uint32 getDurationNsec()
-
getDurationSec
public org.opendaylight.yangtools.yang.common.Uint32 getDurationSec()
-
getHardTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getHardTimeout()
-
getIdleTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getIdleTimeout()
-
getMatch
public Match getMatch()
-
getMatchV10
public MatchV10 getMatchV10()
-
getPacketCount
public org.opendaylight.yangtools.yang.common.Uint64 getPacketCount()
-
getPriority
public org.opendaylight.yangtools.yang.common.Uint16 getPriority()
-
getReason
public FlowRemovedReason getReason()
-
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<FlowRemovedMessage>> E$$ augmentation(Class<E$$> augmentationType)
-
setByteCount
public FlowRemovedMessageBuilder setByteCount(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setCookie
public FlowRemovedMessageBuilder setCookie(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setDurationNsec
public FlowRemovedMessageBuilder setDurationNsec(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setDurationSec
public FlowRemovedMessageBuilder setDurationSec(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setHardTimeout
public FlowRemovedMessageBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setIdleTimeout
public FlowRemovedMessageBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setMatch
public FlowRemovedMessageBuilder setMatch(Match value)
-
setMatchV10
public FlowRemovedMessageBuilder setMatchV10(MatchV10 value)
-
setPacketCount
public FlowRemovedMessageBuilder setPacketCount(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setPriority
public FlowRemovedMessageBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setReason
public FlowRemovedMessageBuilder setReason(FlowRemovedReason value)
-
setTableId
public FlowRemovedMessageBuilder setTableId(TableId value)
-
setVersion
public FlowRemovedMessageBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setXid
public FlowRemovedMessageBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
-
addAugmentation
public FlowRemovedMessageBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowRemovedMessage> 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 FlowRemovedMessageBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowRemovedMessage>> 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 FlowRemovedMessage build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FlowRemovedMessage>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FlowRemovedMessage,IllegalArgumentException>
-
-