All Superinterfaces:: org.opendaylight.yangtools.yang.binding.Augmentable<MatchV10>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<MatchV10Grouping>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

@Generated("mdsal-binding-generator")
public interface MatchV10
extends org.opendaylight.yangtools.yang.binding.ChildOf<MatchV10Grouping>, org.opendaylight.yangtools.yang.binding.Augmentable<MatchV10>

OF v1.0 match structure

This class represents the following YANG schema fragment defined in module openflow-extensible-match

 container match-v10 {
   leaf wildcards {
     type oft:flow-wildcards-v10;
   }
   leaf nw-src-mask {
     type uint8;
   }
   leaf nw-dst-mask {
     type uint8;
   }
   leaf in-port {
     type uint16;
   }
   leaf dl-src {
     type yang:mac-address;
   }
   leaf dl-dst {
     type yang:mac-address;
   }
   leaf dl-vlan {
     type uint16;
   }
   leaf dl-vlan-pcp {
     type uint8;
   }
   leaf dl-type {
     type uint16;
   }
   leaf nw-tos {
     type uint8;
   }
   leaf nw-proto {
     type uint8;
   }
   leaf nw-src {
     type inet:ipv4-address;
   }
   leaf nw-dst {
     type inet:ipv4-address;
   }
   leaf tp-src {
     type uint16;
   }
   leaf tp-dst {
     type uint16;
   }
 }

To create instances of this class use MatchV10Builder.

See Also:: MatchV10Builder

Field Summary

Fields
Modifier and Type Field Description

static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
YANG identifier of the statement represented by this class.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`static boolean`	`bindingEquals(@NonNull MatchV10 thisObj, Object obj)`	Default implementation of `Object.equals(Object)` contract for this interface.
`static int`	`bindingHashCode(@NonNull MatchV10 obj)`	Default implementation of `Object.hashCode()` contract for this interface.
`static String`	`bindingToString(@NonNull MatchV10 obj)`	Default implementation of `Object.toString()` contract for this interface.
`org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress`	`getDlDst()`	Return dlDst, or `null` if it is not present.
`org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress`	`getDlSrc()`	Return dlSrc, or `null` if it is not present.
`org.opendaylight.yangtools.yang.common.Uint16`	`getDlType()`	Return dlType, or `null` if it is not present.
`org.opendaylight.yangtools.yang.common.Uint16`	`getDlVlan()`	Return dlVlan, or `null` if it is not present.
`org.opendaylight.yangtools.yang.common.Uint8`	`getDlVlanPcp()`	Return dlVlanPcp, or `null` if it is not present.
`org.opendaylight.yangtools.yang.common.Uint16`	`getInPort()`	Return inPort, or `null` if it is not present.
`org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address`	`getNwDst()`	Return nwDst, or `null` if it is not present.
`org.opendaylight.yangtools.yang.common.Uint8`	`getNwDstMask()`	Return nwDstMask, or `null` if it is not present.
`org.opendaylight.yangtools.yang.common.Uint8`	`getNwProto()`	Return nwProto, or `null` if it is not present.
`org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address`	`getNwSrc()`	Return nwSrc, or `null` if it is not present.
`org.opendaylight.yangtools.yang.common.Uint8`	`getNwSrcMask()`	Return nwSrcMask, or `null` if it is not present.
`org.opendaylight.yangtools.yang.common.Uint8`	`getNwTos()`	Return nwTos, or `null` if it is not present.
`org.opendaylight.yangtools.yang.common.Uint16`	`getTpDst()`	Return tpDst, or `null` if it is not present.
`org.opendaylight.yangtools.yang.common.Uint16`	`getTpSrc()`	Return tpSrc, or `null` if it is not present.
`FlowWildcardsV10`	`getWildcards()`	Return wildcards, or `null` if it is not present.
`default Class<MatchV10>`	`implementedInterface()`
`default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress`	`requireDlDst()`	Return dlDst, guaranteed to be non-null.
`default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress`	`requireDlSrc()`	Return dlSrc, guaranteed to be non-null.
`default @NonNull org.opendaylight.yangtools.yang.common.Uint16`	`requireDlType()`	Return dlType, guaranteed to be non-null.
`default @NonNull org.opendaylight.yangtools.yang.common.Uint16`	`requireDlVlan()`	Return dlVlan, guaranteed to be non-null.
`default @NonNull org.opendaylight.yangtools.yang.common.Uint8`	`requireDlVlanPcp()`	Return dlVlanPcp, guaranteed to be non-null.
`default @NonNull org.opendaylight.yangtools.yang.common.Uint16`	`requireInPort()`	Return inPort, guaranteed to be non-null.
`default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address`	`requireNwDst()`	Return nwDst, guaranteed to be non-null.
`default @NonNull org.opendaylight.yangtools.yang.common.Uint8`	`requireNwDstMask()`	Return nwDstMask, guaranteed to be non-null.
`default @NonNull org.opendaylight.yangtools.yang.common.Uint8`	`requireNwProto()`	Return nwProto, guaranteed to be non-null.
`default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address`	`requireNwSrc()`	Return nwSrc, guaranteed to be non-null.
`default @NonNull org.opendaylight.yangtools.yang.common.Uint8`	`requireNwSrcMask()`	Return nwSrcMask, guaranteed to be non-null.
`default @NonNull org.opendaylight.yangtools.yang.common.Uint8`	`requireNwTos()`	Return nwTos, guaranteed to be non-null.
`default @NonNull org.opendaylight.yangtools.yang.common.Uint16`	`requireTpDst()`	Return tpDst, guaranteed to be non-null.
`default @NonNull org.opendaylight.yangtools.yang.common.Uint16`	`requireTpSrc()`	Return tpSrc, guaranteed to be non-null.
`default @NonNull FlowWildcardsV10`	`requireWildcards()`	Return wildcards, guaranteed to be non-null.

Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable
augmentation, augmentations

- Field Detail
  - QNAME
```
static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
```
    YANG identifier of the statement represented by this class.
- Method Detail
  - implementedInterface
```
default Class<MatchV10> implementedInterface()
```
    Specified by:
    
    implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
    
    Specified by:
    
    implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
  - bindingHashCode
```
static int bindingHashCode(@NonNull MatchV10 obj)
```
    Default implementation of Object.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 - if obj is null
  - bindingEquals
```
static boolean bindingEquals(@NonNull MatchV10 thisObj,
                             Object obj)
```
    Default implementation of Object.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 invocation
    
    obj - Object acting as argument to equals invocation
    
    Returns:
    
    True if thisObj and obj are considered equal
    
    Throws:
    
    NullPointerException - if thisObj is null
  - bindingToString
```
static String bindingToString(@NonNull MatchV10 obj)
```
    Default implementation of Object.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 - if obj is null
  - getWildcards
```
FlowWildcardsV10 getWildcards()
```
    Return wildcards, or null if it is not present.
    Wildcard fields (only flags).
    Returns:
    
    FlowWildcardsV10 wildcards, or null if it is not present.
  - requireWildcards
```
default @NonNull FlowWildcardsV10 requireWildcards()
```
    Return wildcards, guaranteed to be non-null.
    Wildcard fields (only flags).
    Returns:
    
    FlowWildcardsV10 wildcards, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if wildcards is not present
  - getNwSrcMask
```
org.opendaylight.yangtools.yang.common.Uint8 getNwSrcMask()
```
    Return nwSrcMask, or null if it is not present.
    IP source address mask (definition differs from OF v1.0.0 spec to ease understanding, library does the transformation into OF v1.0 spec correct data)
    Returns:
    
    Uint8 nwSrcMask, or null if it is not present.
  - requireNwSrcMask
```
default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requireNwSrcMask()
```
    Return nwSrcMask, guaranteed to be non-null.
    IP source address mask (definition differs from OF v1.0.0 spec to ease understanding, library does the transformation into OF v1.0 spec correct data)
    Returns:
    
    Uint8 nwSrcMask, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if nwSrcMask is not present
  - getNwDstMask
```
org.opendaylight.yangtools.yang.common.Uint8 getNwDstMask()
```
    Return nwDstMask, or null if it is not present.
    IP destination address mask (definition differs from OF v1.0.0 spec to ease understanding, library does the transformation into OF v1.0 spec correct data)
    Returns:
    
    Uint8 nwDstMask, or null if it is not present.
  - requireNwDstMask
```
default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requireNwDstMask()
```
    Return nwDstMask, guaranteed to be non-null.
    IP destination address mask (definition differs from OF v1.0.0 spec to ease understanding, library does the transformation into OF v1.0 spec correct data)
    Returns:
    
    Uint8 nwDstMask, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if nwDstMask is not present
  - getInPort
```
org.opendaylight.yangtools.yang.common.Uint16 getInPort()
```
    Return inPort, or null if it is not present.
    Input switch port.
    Returns:
    
    Uint16 inPort, or null if it is not present.
  - requireInPort
```
default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireInPort()
```
    Return inPort, guaranteed to be non-null.
    Input switch port.
    Returns:
    
    Uint16 inPort, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if inPort is not present
  - getDlSrc
```
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getDlSrc()
```
    Return dlSrc, or null if it is not present.
    Ethernet source address.
    Returns:
    
    MacAddress dlSrc, or null if it is not present.
  - requireDlSrc
```
default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress requireDlSrc()
```
    Return dlSrc, guaranteed to be non-null.
    Ethernet source address.
    Returns:
    
    MacAddress dlSrc, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if dlSrc is not present
  - getDlDst
```
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getDlDst()
```
    Return dlDst, or null if it is not present.
    Ethernet destination address.
    Returns:
    
    MacAddress dlDst, or null if it is not present.
  - requireDlDst
```
default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress requireDlDst()
```
    Return dlDst, guaranteed to be non-null.
    Ethernet destination address.
    Returns:
    
    MacAddress dlDst, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if dlDst is not present
  - getDlVlan
```
org.opendaylight.yangtools.yang.common.Uint16 getDlVlan()
```
    Return dlVlan, or null if it is not present.
    Input VLAN id.
    Returns:
    
    Uint16 dlVlan, or null if it is not present.
  - requireDlVlan
```
default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireDlVlan()
```
    Return dlVlan, guaranteed to be non-null.
    Input VLAN id.
    Returns:
    
    Uint16 dlVlan, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if dlVlan is not present
  - getDlVlanPcp
```
org.opendaylight.yangtools.yang.common.Uint8 getDlVlanPcp()
```
    Return dlVlanPcp, or null if it is not present.
    Input VLAN priority.
    Returns:
    
    Uint8 dlVlanPcp, or null if it is not present.
  - requireDlVlanPcp
```
default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requireDlVlanPcp()
```
    Return dlVlanPcp, guaranteed to be non-null.
    Input VLAN priority.
    Returns:
    
    Uint8 dlVlanPcp, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if dlVlanPcp is not present
  - getDlType
```
org.opendaylight.yangtools.yang.common.Uint16 getDlType()
```
    Return dlType, or null if it is not present.
    Ethernet frame type.
    Returns:
    
    Uint16 dlType, or null if it is not present.
  - requireDlType
```
default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireDlType()
```
    Return dlType, guaranteed to be non-null.
    Ethernet frame type.
    Returns:
    
    Uint16 dlType, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if dlType is not present
  - getNwTos
```
org.opendaylight.yangtools.yang.common.Uint8 getNwTos()
```
    Return nwTos, or null if it is not present.
    IP ToS (actually DSCP field, 6 bits).
    Returns:
    
    Uint8 nwTos, or null if it is not present.
  - requireNwTos
```
default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requireNwTos()
```
    Return nwTos, guaranteed to be non-null.
    IP ToS (actually DSCP field, 6 bits).
    Returns:
    
    Uint8 nwTos, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if nwTos is not present
  - getNwProto
```
org.opendaylight.yangtools.yang.common.Uint8 getNwProto()
```
    Return nwProto, or null if it is not present.
    IP protocol or lower 8 bits of ARP opcode.
    Returns:
    
    Uint8 nwProto, or null if it is not present.
  - requireNwProto
```
default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requireNwProto()
```
    Return nwProto, guaranteed to be non-null.
    IP protocol or lower 8 bits of ARP opcode.
    Returns:
    
    Uint8 nwProto, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if nwProto is not present
  - getNwSrc
```
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getNwSrc()
```
    Return nwSrc, or null if it is not present.
    IP source address.
    Returns:
    
    Ipv4Address nwSrc, or null if it is not present.
  - requireNwSrc
```
default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address requireNwSrc()
```
    Return nwSrc, guaranteed to be non-null.
    IP source address.
    Returns:
    
    Ipv4Address nwSrc, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if nwSrc is not present
  - getNwDst
```
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getNwDst()
```
    Return nwDst, or null if it is not present.
    IP destination address.
    Returns:
    
    Ipv4Address nwDst, or null if it is not present.
  - requireNwDst
```
default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address requireNwDst()
```
    Return nwDst, guaranteed to be non-null.
    IP destination address.
    Returns:
    
    Ipv4Address nwDst, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if nwDst is not present
  - getTpSrc
```
org.opendaylight.yangtools.yang.common.Uint16 getTpSrc()
```
    Return tpSrc, or null if it is not present.
    TCP/UDP source port.
    Returns:
    
    Uint16 tpSrc, or null if it is not present.
  - requireTpSrc
```
default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireTpSrc()
```
    Return tpSrc, guaranteed to be non-null.
    TCP/UDP source port.
    Returns:
    
    Uint16 tpSrc, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if tpSrc is not present
  - getTpDst
```
org.opendaylight.yangtools.yang.common.Uint16 getTpDst()
```
    Return tpDst, or null if it is not present.
    TCP/UDP destination port.
    Returns:
    
    Uint16 tpDst, or null if it is not present.
  - requireTpDst
```
default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireTpDst()
```
    Return tpDst, guaranteed to be non-null.
    TCP/UDP destination port.
    Returns:
    
    Uint16 tpDst, guaranteed to be non-null.
    
    Throws:
    
    NoSuchElementException - if tpDst is not present

Interface MatchV10

Field Summary

Method Summary

Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

Field Detail

QNAME

Method Detail

implementedInterface

bindingHashCode

bindingEquals

bindingToString

getWildcards

requireWildcards

getNwSrcMask

requireNwSrcMask

getNwDstMask

requireNwDstMask

getInPort

requireInPort

getDlSrc

requireDlSrc

getDlDst

requireDlDst

getDlVlan

requireDlVlan

getDlVlanPcp

requireDlVlanPcp

getDlType

requireDlType

getNwTos

requireNwTos

getNwProto

requireNwProto

getNwSrc

requireNwSrc

getNwDst

requireNwDst

getTpSrc

requireTpSrc

getTpDst

requireTpDst