Interface Flow
-
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<Flow>
,org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.ChildOf<Table>
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
,Flow
,GenericFlowAttributes
,org.opendaylight.yangtools.yang.binding.Identifiable<FlowKey>
@Generated("mdsal-binding-generator") public interface Flow extends org.opendaylight.yangtools.yang.binding.ChildOf<Table>, org.opendaylight.yangtools.yang.binding.Augmentable<Flow>, Flow, org.opendaylight.yangtools.yang.binding.Identifiable<FlowKey>
This class represents the following YANG schema fragment defined in module flow-node-inventory
list flow { key id; leaf id { type flow-id; } uses flow:flow; }
The schema path to identify an instance is flow-node-inventorytablestableflowTo create instances of this class use
FlowBuilder
.- See Also:
FlowBuilder
,FlowKey
-
-
Field Summary
Fields Modifier and Type Field Description static @NonNull org.opendaylight.yangtools.yang.common.QName
QNAME
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description static boolean
bindingEquals(@NonNull Flow thisObj, Object obj)
Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode(@NonNull Flow obj)
Default implementation ofObject.hashCode()
contract for this interface.static String
bindingToString(@NonNull Flow obj)
Default implementation ofObject.toString()
contract for this interface.FlowId
getId()
Return id, ornull
if it is not present.default Class<Flow>
implementedInterface()
FlowKey
key()
default @NonNull FlowId
requireId()
Return id, guaranteed to be non-null.-
Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable
augmentation, augmentations
-
Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.Flow
getBarrier, getBufferId, getContainerName, getCookieMask, getFlags, getFlowName, getInstallHw, getInstructions, getMatch, getOutGroup, getOutPort, getStrict, requireBarrier, requireBufferId, requireContainerName, requireCookieMask, requireFlags, requireFlowName, requireInstallHw, requireOutGroup, requireOutPort, requireStrict
-
Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.GenericFlowAttributes
getCookie, getHardTimeout, getIdleTimeout, getPriority, getTableId, requireCookie, requireHardTimeout, requireIdleTimeout, requirePriority, requireTableId
-
-
-
-
Method Detail
-
implementedInterface
default Class<Flow> implementedInterface()
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataContainer
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataObject
- Specified by:
implementedInterface
in interfaceFlow
- Specified by:
implementedInterface
in interfaceGenericFlowAttributes
-
bindingHashCode
static int bindingHashCode(@NonNull Flow obj)
Default implementation ofObject.hashCode()
contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.- Parameters:
obj
- Object for which to generate hashCode() result.- Returns:
- Hash code value of data modeled by this interface.
- Throws:
NullPointerException
- ifobj
is null
-
bindingEquals
static boolean bindingEquals(@NonNull Flow thisObj, Object obj)
Default implementation ofObject.equals(Object)
contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.- Parameters:
thisObj
- Object acting as the receiver of equals invocationobj
- Object acting as argument to equals invocation- Returns:
- True if thisObj and obj are considered equal
- Throws:
NullPointerException
- ifthisObj
is null
-
bindingToString
static String bindingToString(@NonNull Flow obj)
Default implementation ofObject.toString()
contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.- Parameters:
obj
- Object for which to generate toString() result.- Returns:
String
value of data modeled by this interface.- Throws:
NullPointerException
- ifobj
is null
-
key
FlowKey key()
- Specified by:
key
in interfaceorg.opendaylight.yangtools.yang.binding.Identifiable<FlowKey>
-
getId
FlowId getId()
Return id, ornull
if it is not present.- Returns:
FlowId
id, ornull
if it is not present.
-
requireId
default @NonNull FlowId requireId()
Return id, guaranteed to be non-null.- Returns:
FlowId
id, guaranteed to be non-null.- Throws:
NoSuchElementException
- if id is not present
-
-