Class SwitchFlowRemovedBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SwitchFlowRemovedBuilder
-
@Generated("mdsal-binding-generator") public class SwitchFlowRemovedBuilder extends Object
Class that buildsSwitchFlowRemoved
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:
SwitchFlowRemoved createSwitchFlowRemoved(int fooXyzzy, int barBaz) { return new SwitchFlowRemovedBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SwitchFlowRemoved, 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:
SwitchFlowRemoved
- 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
-
-
Constructor Summary
Constructors Constructor Description SwitchFlowRemovedBuilder()
Construct an empty builder.SwitchFlowRemovedBuilder(NodeFlowRemoved arg)
Construct a new builder initialized from specifiedNodeFlowRemoved
.SwitchFlowRemovedBuilder(SwitchFlowRemoved base)
Construct a builder initialized with state from specifiedSwitchFlowRemoved
.SwitchFlowRemovedBuilder(FlowModRemoved arg)
Construct a new builder initialized from specifiedFlowModRemoved
.SwitchFlowRemovedBuilder(GenericFlowAttributes arg)
Construct a new builder initialized from specifiedGenericFlowAttributes
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SwitchFlowRemovedBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SwitchFlowRemoved> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SwitchFlowRemoved>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SwitchFlowRemoved
build()
A newSwitchFlowRemoved
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint64
getByteCount()
Return current value associated with the property corresponding toFlowModRemoved.getByteCount()
.FlowCookie
getCookie()
Return current value associated with the property corresponding toGenericFlowAttributes.getCookie()
.org.opendaylight.yangtools.yang.common.Uint32
getDurationNsec()
Return current value associated with the property corresponding toFlowModRemoved.getDurationNsec()
.org.opendaylight.yangtools.yang.common.Uint32
getDurationSec()
Return current value associated with the property corresponding toFlowModRemoved.getDurationSec()
.FlowTableRef
getFlowTable()
Return current value associated with the property corresponding toNodeFlowRemoved.getFlowTable()
.org.opendaylight.yangtools.yang.common.Uint16
getHardTimeout()
Return current value associated with the property corresponding toGenericFlowAttributes.getHardTimeout()
.org.opendaylight.yangtools.yang.common.Uint16
getIdleTimeout()
Return current value associated with the property corresponding toGenericFlowAttributes.getIdleTimeout()
.Match
getMatch()
Return current value associated with the property corresponding toFlowModRemoved.getMatch()
.NodeRef
getNode()
Return current value associated with the property corresponding toNodeFlowRemoved.getNode()
.org.opendaylight.yangtools.yang.common.Uint64
getPacketCount()
Return current value associated with the property corresponding toFlowModRemoved.getPacketCount()
.org.opendaylight.yangtools.yang.common.Uint16
getPriority()
Return current value associated with the property corresponding toGenericFlowAttributes.getPriority()
.RemovedFlowReason
getRemovedReason()
Return current value associated with the property corresponding toFlowModRemoved.getRemovedReason()
.org.opendaylight.yangtools.yang.common.Uint8
getTableId()
Return current value associated with the property corresponding toGenericFlowAttributes.getTableId()
.SwitchFlowRemovedBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SwitchFlowRemoved>> augmentationType)
Remove an augmentation from this builder's product.SwitchFlowRemovedBuilder
setByteCount(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toFlowModRemoved.getByteCount()
to the specified value.SwitchFlowRemovedBuilder
setCookie(FlowCookie value)
Set the property corresponding toGenericFlowAttributes.getCookie()
to the specified value.SwitchFlowRemovedBuilder
setDurationNsec(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toFlowModRemoved.getDurationNsec()
to the specified value.SwitchFlowRemovedBuilder
setDurationSec(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toFlowModRemoved.getDurationSec()
to the specified value.SwitchFlowRemovedBuilder
setFlowTable(FlowTableRef value)
Set the property corresponding toNodeFlowRemoved.getFlowTable()
to the specified value.SwitchFlowRemovedBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toGenericFlowAttributes.getHardTimeout()
to the specified value.SwitchFlowRemovedBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toGenericFlowAttributes.getIdleTimeout()
to the specified value.SwitchFlowRemovedBuilder
setMatch(Match value)
Set the property corresponding toFlowModRemoved.getMatch()
to the specified value.SwitchFlowRemovedBuilder
setNode(NodeRef value)
Set the property corresponding toNodeFlowRemoved.getNode()
to the specified value.SwitchFlowRemovedBuilder
setPacketCount(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toFlowModRemoved.getPacketCount()
to the specified value.SwitchFlowRemovedBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toGenericFlowAttributes.getPriority()
to the specified value.SwitchFlowRemovedBuilder
setRemovedReason(RemovedFlowReason value)
Set the property corresponding toFlowModRemoved.getRemovedReason()
to the specified value.SwitchFlowRemovedBuilder
setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toGenericFlowAttributes.getTableId()
to the specified value.
-
-
-
Constructor Detail
-
SwitchFlowRemovedBuilder
public SwitchFlowRemovedBuilder()
Construct an empty builder.
-
SwitchFlowRemovedBuilder
public SwitchFlowRemovedBuilder(NodeFlowRemoved arg)
Construct a new builder initialized from specifiedNodeFlowRemoved
.- Parameters:
arg
- NodeFlowRemoved from which the builder should be initialized
-
SwitchFlowRemovedBuilder
public SwitchFlowRemovedBuilder(FlowModRemoved arg)
Construct a new builder initialized from specifiedFlowModRemoved
.- Parameters:
arg
- FlowModRemoved from which the builder should be initialized
-
SwitchFlowRemovedBuilder
public SwitchFlowRemovedBuilder(GenericFlowAttributes arg)
Construct a new builder initialized from specifiedGenericFlowAttributes
.- Parameters:
arg
- GenericFlowAttributes from which the builder should be initialized
-
SwitchFlowRemovedBuilder
public SwitchFlowRemovedBuilder(SwitchFlowRemoved base)
Construct a builder initialized with state from specifiedSwitchFlowRemoved
.- Parameters:
base
- SwitchFlowRemoved from which the builder should be initialized
-
-
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:- 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()
Return current value associated with the property corresponding toFlowModRemoved.getByteCount()
.- Returns:
- current value
-
getCookie
public FlowCookie getCookie()
Return current value associated with the property corresponding toGenericFlowAttributes.getCookie()
.- Returns:
- current value
-
getDurationNsec
public org.opendaylight.yangtools.yang.common.Uint32 getDurationNsec()
Return current value associated with the property corresponding toFlowModRemoved.getDurationNsec()
.- Returns:
- current value
-
getDurationSec
public org.opendaylight.yangtools.yang.common.Uint32 getDurationSec()
Return current value associated with the property corresponding toFlowModRemoved.getDurationSec()
.- Returns:
- current value
-
getFlowTable
public FlowTableRef getFlowTable()
Return current value associated with the property corresponding toNodeFlowRemoved.getFlowTable()
.- Returns:
- current value
-
getHardTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getHardTimeout()
Return current value associated with the property corresponding toGenericFlowAttributes.getHardTimeout()
.- Returns:
- current value
-
getIdleTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getIdleTimeout()
Return current value associated with the property corresponding toGenericFlowAttributes.getIdleTimeout()
.- Returns:
- current value
-
getMatch
public Match getMatch()
Return current value associated with the property corresponding toFlowModRemoved.getMatch()
.- Returns:
- current value
-
getNode
public NodeRef getNode()
Return current value associated with the property corresponding toNodeFlowRemoved.getNode()
.- Returns:
- current value
-
getPacketCount
public org.opendaylight.yangtools.yang.common.Uint64 getPacketCount()
Return current value associated with the property corresponding toFlowModRemoved.getPacketCount()
.- Returns:
- current value
-
getPriority
public org.opendaylight.yangtools.yang.common.Uint16 getPriority()
Return current value associated with the property corresponding toGenericFlowAttributes.getPriority()
.- Returns:
- current value
-
getRemovedReason
public RemovedFlowReason getRemovedReason()
Return current value associated with the property corresponding toFlowModRemoved.getRemovedReason()
.- Returns:
- current value
-
getTableId
public org.opendaylight.yangtools.yang.common.Uint8 getTableId()
Return current value associated with the property corresponding toGenericFlowAttributes.getTableId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SwitchFlowRemoved>> 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
-
setByteCount
public SwitchFlowRemovedBuilder setByteCount(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toFlowModRemoved.getByteCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCookie
public SwitchFlowRemovedBuilder setCookie(FlowCookie value)
Set the property corresponding toGenericFlowAttributes.getCookie()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDurationNsec
public SwitchFlowRemovedBuilder setDurationNsec(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toFlowModRemoved.getDurationNsec()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDurationSec
public SwitchFlowRemovedBuilder setDurationSec(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toFlowModRemoved.getDurationSec()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlowTable
public SwitchFlowRemovedBuilder setFlowTable(FlowTableRef value)
Set the property corresponding toNodeFlowRemoved.getFlowTable()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setHardTimeout
public SwitchFlowRemovedBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toGenericFlowAttributes.getHardTimeout()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIdleTimeout
public SwitchFlowRemovedBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toGenericFlowAttributes.getIdleTimeout()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMatch
public SwitchFlowRemovedBuilder setMatch(Match value)
Set the property corresponding toFlowModRemoved.getMatch()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNode
public SwitchFlowRemovedBuilder setNode(NodeRef value)
Set the property corresponding toNodeFlowRemoved.getNode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPacketCount
public SwitchFlowRemovedBuilder setPacketCount(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toFlowModRemoved.getPacketCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPriority
public SwitchFlowRemovedBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toGenericFlowAttributes.getPriority()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRemovedReason
public SwitchFlowRemovedBuilder setRemovedReason(RemovedFlowReason value)
Set the property corresponding toFlowModRemoved.getRemovedReason()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTableId
public SwitchFlowRemovedBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toGenericFlowAttributes.getTableId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SwitchFlowRemovedBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SwitchFlowRemoved> 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 SwitchFlowRemovedBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SwitchFlowRemoved>> 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 @NonNull SwitchFlowRemoved build()
A newSwitchFlowRemoved
instance.- Returns:
- A new
SwitchFlowRemoved
instance.
-
-