PiOptionalFieldMatch (ONOS Java API (2.5.5))

java.lang.Object
- org.onosproject.net.pi.runtime.PiFieldMatch
- - org.onosproject.net.pi.runtime.PiOptionalFieldMatch

```
@Beta
public final class PiOptionalFieldMatch
extends PiFieldMatch
```
Instance of an optional field match in a protocol-independent pipeline. The optional match field behaves like an exact match if specified, otherwise it is logically equivalent to a wildcard match.

Constructor Summary

Constructors
Constructor Description

PiOptionalFieldMatch(PiMatchFieldId fieldId, ImmutableByteSequence value)
Creates an optional field match.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`String`	`toString()`
`PiMatchType`	`type()`	Returns the type of match to be performed.
`ImmutableByteSequence`	`value()`	Returns the byte sequence value to be matched.

Methods inherited from class org.onosproject.net.pi.runtime.PiFieldMatch
fieldId

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PiOptionalFieldMatch
```
public PiOptionalFieldMatch(PiMatchFieldId fieldId,
                            ImmutableByteSequence value)
```
    Creates an optional field match.
    
    Parameters:
    
    fieldId - field identifier
    
    value - value
- Method Detail
  - type
```
public PiMatchType type()
```
    Description copied from class: PiFieldMatch
    
    Returns the type of match to be performed.
    
    Specified by:
    
    type in class PiFieldMatch
    
    Returns:
    
    a match type value
  - value
```
public ImmutableByteSequence value()
```
    Returns the byte sequence value to be matched.
    
    Returns:
    
    an immutable byte sequence
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object