PiCriterion (ONOS Java API (2.7.0))

java.lang.Object
- org.onosproject.net.flow.criteria.PiCriterion

All Implemented Interfaces:: Criterion

@Beta
public final class PiCriterion
extends Object
implements Criterion

Protocol-independent criterion.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class PiCriterion.Builder
PiCriterion Builder.
- Nested classes/interfaces inherited from interface org.onosproject.net.flow.criteria.Criterion
  Criterion.IPv6ExthdrFlags, Criterion.TcpFlags, Criterion.Type

Field Summary
- Fields inherited from interface org.onosproject.net.flow.criteria.Criterion
  SEPARATOR

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static PiCriterion.Builder`	`builder()`	Returns the PiCriterion builder.
`static PiCriterion.Builder`	`builder(PiCriterion piCriterion)`	Returns the PiCriterion builder initialized by the given PiCriterion.
`boolean`	`equals(Object o)`
`Optional<PiFieldMatch>`	`fieldMatch(PiMatchFieldId fieldId)`	If present, returns the field match associated with the given header field identifier.
`Collection<PiFieldMatch>`	`fieldMatches()`	Returns all protocol-independent field matches defined by this criterion.
`int`	`hashCode()`
`String`	`toString()`
`Criterion.Type`	`type()`	Returns the type of criterion.

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

- Method Detail
  - fieldMatches
```
public Collection<PiFieldMatch> fieldMatches()
```
    Returns all protocol-independent field matches defined by this criterion.
    
    Returns:
    
    collection of match parameters
  - fieldMatch
```
public Optional<PiFieldMatch> fieldMatch(PiMatchFieldId fieldId)
```
    If present, returns the field match associated with the given header field identifier.
    
    Parameters:
    
    fieldId - field identifier
    
    Returns:
    
    optional field match
  - type
```
public Criterion.Type type()
```
    Description copied from interface: Criterion
    
    Returns the type of criterion.
    
    Specified by:
    
    type in interface Criterion
    
    Returns:
    
    type of criterion
  - 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
  - builder
```
public static PiCriterion.Builder builder()
```
    Returns the PiCriterion builder.
    
    Returns:
    
    PiCriterion builder
  - builder
```
public static PiCriterion.Builder builder(PiCriterion piCriterion)
```
    Returns the PiCriterion builder initialized by the given PiCriterion.
    
    Parameters:
    
    piCriterion - the input PiCriterion
    
    Returns:
    
    PiCriterion builder