org.onosproject.net.flow.criteria

Class PiCriterion.Builder

java.lang.Object

org.onosproject.net.flow.criteria.PiCriterion.Builder

Enclosing class:

PiCriterion

@Beta
public static final class PiCriterion.Builder
extends Object

PiCriterion Builder.

Method Summary

Modifier and Type	Method and Description
Criterion	build() Builds a PiCriterion.
PiCriterion.Builder	matchExact(PiHeaderFieldId fieldId, byte[] value) Adds an exact field match for the given fieldId and value.
PiCriterion.Builder	matchExact(PiHeaderFieldId fieldId, int value) Adds an exact field match for the given fieldId and value.
PiCriterion.Builder	matchExact(PiHeaderFieldId fieldId, long value) Adds an exact field match for the given fieldId and value.
PiCriterion.Builder	matchExact(PiHeaderFieldId fieldId, short value) Adds an exact field match for the given fieldId and value.
PiCriterion.Builder	matchLpm(PiHeaderFieldId fieldId, byte[] value, int prefixLength) Adds a longest-prefix field match for the given fieldId, value and prefix length.
PiCriterion.Builder	matchLpm(PiHeaderFieldId fieldId, int value, int prefixLength) Adds a longest-prefix field match for the given fieldId, value and prefix length.
PiCriterion.Builder	matchLpm(PiHeaderFieldId fieldId, long value, int prefixLength) Adds a longest-prefix field match for the given fieldId, value and prefix length.
PiCriterion.Builder	matchLpm(PiHeaderFieldId fieldId, short value, int prefixLength) Adds a longest-prefix field match for the given fieldId, value and prefix length.
PiCriterion.Builder	matchRange(PiHeaderFieldId fieldId, byte[] low, byte[] high) Adds a range field match for the given fieldId, low and high.
PiCriterion.Builder	matchRange(PiHeaderFieldId fieldId, int low, int high) Adds a range field match for the given fieldId, low and high.
PiCriterion.Builder	matchRange(PiHeaderFieldId fieldId, long low, long high) Adds a range field match for the given fieldId, low and high.
PiCriterion.Builder	matchRange(PiHeaderFieldId fieldId, short low, short high) Adds a range field match for the given fieldId, low and high.
PiCriterion.Builder	matchTernary(PiHeaderFieldId fieldId, byte[] value, byte[] mask) Adds a ternary field match for the given fieldId, value and mask.
PiCriterion.Builder	matchTernary(PiHeaderFieldId fieldId, int value, int mask) Adds a ternary field match for the given fieldId, value and mask.
PiCriterion.Builder	matchTernary(PiHeaderFieldId fieldId, long value, long mask) Adds a ternary field match for the given fieldId, value and mask.
PiCriterion.Builder	matchTernary(PiHeaderFieldId fieldId, short value, short mask) Adds a ternary field match for the given fieldId, value and mask.
PiCriterion.Builder	matchValid(PiHeaderFieldId fieldId, boolean flag) Adds a valid field match for the given fieldId and flag.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

matchExact

public PiCriterion.Builder matchExact(PiHeaderFieldId fieldId,
                                      short value)

Adds an exact field match for the given fieldId and value.

Parameters:

fieldId - protocol-independent header field Id

value - exact match value

Returns:

this

matchExact

public PiCriterion.Builder matchExact(PiHeaderFieldId fieldId,
                                      int value)

Adds an exact field match for the given fieldId and value.

Parameters:

fieldId - protocol-independent header field Id

value - exact match value

Returns:

this

matchExact

public PiCriterion.Builder matchExact(PiHeaderFieldId fieldId,
                                      long value)

Adds an exact field match for the given fieldId and value.

Parameters:

fieldId - protocol-independent header field Id

value - exact match value

Returns:

this

matchExact

public PiCriterion.Builder matchExact(PiHeaderFieldId fieldId,
                                      byte[] value)

Adds an exact field match for the given fieldId and value.

Parameters:

fieldId - protocol-independent header field Id

value - exact match value

Returns:

this

matchTernary

public PiCriterion.Builder matchTernary(PiHeaderFieldId fieldId,
                                        short value,
                                        short mask)

Adds a ternary field match for the given fieldId, value and mask.

Parameters:

fieldId - protocol-independent header field Id

value - ternary match value

mask - ternary match mask

Returns:

this

matchTernary

public PiCriterion.Builder matchTernary(PiHeaderFieldId fieldId,
                                        int value,
                                        int mask)

Adds a ternary field match for the given fieldId, value and mask.

Parameters:

fieldId - protocol-independent header field Id

value - ternary match value

mask - ternary match mask

Returns:

this

matchTernary

public PiCriterion.Builder matchTernary(PiHeaderFieldId fieldId,
                                        long value,
                                        long mask)

Adds a ternary field match for the given fieldId, value and mask.

Parameters:

fieldId - protocol-independent header field Id

value - ternary match value

mask - ternary match mask

Returns:

this

matchTernary

public PiCriterion.Builder matchTernary(PiHeaderFieldId fieldId,
                                        byte[] value,
                                        byte[] mask)

Adds a ternary field match for the given fieldId, value and mask.

Parameters:

fieldId - protocol-independent header field Id

value - ternary match value

mask - ternary match mask

Returns:

this

matchLpm

public PiCriterion.Builder matchLpm(PiHeaderFieldId fieldId,
                                    short value,
                                    int prefixLength)

Adds a longest-prefix field match for the given fieldId, value and prefix length.

Parameters:

fieldId - protocol-independent header field Id

value - lpm match value

prefixLength - lpm match prefix length

Returns:

this

matchLpm

public PiCriterion.Builder matchLpm(PiHeaderFieldId fieldId,
                                    int value,
                                    int prefixLength)

Adds a longest-prefix field match for the given fieldId, value and prefix length.

Parameters:

fieldId - protocol-independent header field Id

value - lpm match value

prefixLength - lpm match prefix length

Returns:

this

matchLpm

public PiCriterion.Builder matchLpm(PiHeaderFieldId fieldId,
                                    long value,
                                    int prefixLength)

Adds a longest-prefix field match for the given fieldId, value and prefix length.

Parameters:

fieldId - protocol-independent header field Id

value - lpm match value

prefixLength - lpm match prefix length

Returns:

this

matchLpm

public PiCriterion.Builder matchLpm(PiHeaderFieldId fieldId,
                                    byte[] value,
                                    int prefixLength)

Adds a longest-prefix field match for the given fieldId, value and prefix length.

Parameters:

fieldId - protocol-independent header field Id

value - lpm match value

prefixLength - lpm match prefix length

Returns:

this

matchValid

public PiCriterion.Builder matchValid(PiHeaderFieldId fieldId,
                                      boolean flag)

Adds a valid field match for the given fieldId and flag.

Parameters:

fieldId - protocol-independent header field Id

flag - a boolean value

Returns:

this

matchRange

public PiCriterion.Builder matchRange(PiHeaderFieldId fieldId,
                                      short low,
                                      short high)

Adds a range field match for the given fieldId, low and high.

Parameters:

fieldId - protocol-independent header field Id

low - range match low value

high - range match high value

Returns:

this

matchRange

public PiCriterion.Builder matchRange(PiHeaderFieldId fieldId,
                                      int low,
                                      int high)

Adds a range field match for the given fieldId, low and high.

Parameters:

fieldId - protocol-independent header field Id

low - range match low value

high - range match high value

Returns:

this

matchRange

public PiCriterion.Builder matchRange(PiHeaderFieldId fieldId,
                                      long low,
                                      long high)

Adds a range field match for the given fieldId, low and high.

Parameters:

fieldId - protocol-independent header field Id

low - range match low value

high - range match high value

Returns:

this

matchRange

public PiCriterion.Builder matchRange(PiHeaderFieldId fieldId,
                                      byte[] low,
                                      byte[] high)

Adds a range field match for the given fieldId, low and high.

Parameters:

fieldId - protocol-independent header field Id

low - range match low value

high - range match high value

Returns:

this

build

public Criterion build()

Builds a PiCriterion.

Returns:

PiCriterion