Class SwitchFlowRemovedBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SwitchFlowRemovedBuilder
Class that builds
SwitchFlowRemoved
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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedNodeFlowRemoved
.Construct a builder initialized with state from specifiedSwitchFlowRemoved
.Construct a new builder initialized from specifiedFlowModRemoved
.Construct a new builder initialized from specifiedGenericFlowAttributes
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(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
Return current value associated with the property corresponding toFlowModRemoved.getByteCount()
.Return current value associated with the property corresponding toGenericFlowAttributes.getCookie()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toFlowModRemoved.getDurationNsec()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toFlowModRemoved.getDurationSec()
.Return current value associated with the property corresponding toNodeFlowRemoved.getFlowTable()
.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toGenericFlowAttributes.getHardTimeout()
.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toGenericFlowAttributes.getIdleTimeout()
.getMatch()
Return current value associated with the property corresponding toFlowModRemoved.getMatch()
.getNode()
Return current value associated with the property corresponding toNodeFlowRemoved.getNode()
.org.opendaylight.yangtools.yang.common.Uint64
Return current value associated with the property corresponding toFlowModRemoved.getPacketCount()
.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toGenericFlowAttributes.getPriority()
.Return current value associated with the property corresponding toFlowModRemoved.getRemovedReason()
.org.opendaylight.yangtools.yang.common.Uint8
Return current value associated with the property corresponding toGenericFlowAttributes.getTableId()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SwitchFlowRemoved>> augmentationType) Remove an augmentation from this builder's product.setByteCount
(org.opendaylight.yangtools.yang.common.Uint64 value) Set the property corresponding toFlowModRemoved.getByteCount()
to the specified value.setCookie
(FlowCookie value) Set the property corresponding toGenericFlowAttributes.getCookie()
to the specified value.setDurationNsec
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toFlowModRemoved.getDurationNsec()
to the specified value.setDurationSec
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toFlowModRemoved.getDurationSec()
to the specified value.setFlowTable
(FlowTableRef value) Set the property corresponding toNodeFlowRemoved.getFlowTable()
to the specified value.setHardTimeout
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toGenericFlowAttributes.getHardTimeout()
to the specified value.setIdleTimeout
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toGenericFlowAttributes.getIdleTimeout()
to the specified value.Set the property corresponding toFlowModRemoved.getMatch()
to the specified value.Set the property corresponding toNodeFlowRemoved.getNode()
to the specified value.setPacketCount
(org.opendaylight.yangtools.yang.common.Uint64 value) Set the property corresponding toFlowModRemoved.getPacketCount()
to the specified value.setPriority
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toGenericFlowAttributes.getPriority()
to the specified value.Set the property corresponding toFlowModRemoved.getRemovedReason()
to the specified value.setTableId
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toGenericFlowAttributes.getTableId()
to the specified value.
-
Constructor Details
-
SwitchFlowRemovedBuilder
public SwitchFlowRemovedBuilder()Construct an empty builder. -
SwitchFlowRemovedBuilder
Construct a new builder initialized from specifiedNodeFlowRemoved
.- Parameters:
arg
- NodeFlowRemoved from which the builder should be initialized
-
SwitchFlowRemovedBuilder
Construct a new builder initialized from specifiedFlowModRemoved
.- Parameters:
arg
- FlowModRemoved from which the builder should be initialized
-
SwitchFlowRemovedBuilder
Construct a new builder initialized from specifiedGenericFlowAttributes
.- Parameters:
arg
- GenericFlowAttributes from which the builder should be initialized
-
SwitchFlowRemovedBuilder
Construct a builder initialized with state from specifiedSwitchFlowRemoved
.- Parameters:
base
- SwitchFlowRemoved from which the builder should be initialized
-
-
Method Details
-
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
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
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
Return current value associated with the property corresponding toFlowModRemoved.getMatch()
.- Returns:
- current value
-
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
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
Set the property corresponding toFlowModRemoved.getByteCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCookie
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
Set the property corresponding toFlowModRemoved.getDurationSec()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlowTable
Set the property corresponding toNodeFlowRemoved.getFlowTable()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setHardTimeout
Set the property corresponding toGenericFlowAttributes.getHardTimeout()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIdleTimeout
Set the property corresponding toGenericFlowAttributes.getIdleTimeout()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMatch
Set the property corresponding toFlowModRemoved.getMatch()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNode
Set the property corresponding toNodeFlowRemoved.getNode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPacketCount
Set the property corresponding toFlowModRemoved.getPacketCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPriority
Set the property corresponding toGenericFlowAttributes.getPriority()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRemovedReason
Set the property corresponding toFlowModRemoved.getRemovedReason()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTableId
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
A newSwitchFlowRemoved
instance.- Returns:
- A new
SwitchFlowRemoved
instance.
-