org.projectfloodlight.openflow.protocol.match

Interface Match.Builder

All Known Subinterfaces:

OFMatchV1.Builder, OFMatchV2.Builder, OFMatchV3.Builder

Enclosing interface:

Match

public static interface Match.Builder

Builder interface for Match objects. Builder is used to create new Match objects and it creates the match according to the version it corresponds to. The builder uses the same notation of wildcards and masks, and can also throw UnsupportedOperationException if it is asked to create some matching that is not supported in the version it represents. While used, MatchBuilder may not be consistent in terms of field prerequisites. However, user must solve these before using the generated Match object as these prerequisites should be enforced in the getters.

Author:

Yotam Harchol (yotam.harchol@bigswitch.com)

Method Summary

Methods

Modifier and Type	Method and Description
Match	build() Returns the match created by this builder.
<F extends OFValueType<F>> F	get(MatchField<F> field)
<F extends OFValueType<F>> Masked<F>	getMasked(MatchField<F> field)
boolean	isExact(MatchField<?> field)
boolean	isFullyWildcarded(MatchField<?> field)
boolean	isPartiallyMasked(MatchField<?> field)
<F extends OFValueType<F>> Match.Builder	setExact(MatchField<F> field, F value) Sets a specific exact value for a field.
<F extends OFValueType<F>> Match.Builder	setMasked(MatchField<F> field, F value, F mask) Sets a masked value for a field.
<F extends OFValueType<F>> Match.Builder	setMasked(MatchField<F> field, Masked<F> valueWithMask) Sets a masked value for a field.
boolean	supports(MatchField<?> field)
boolean	supportsMasked(MatchField<?> field)
<F extends OFValueType<F>> Match.Builder	wildcard(MatchField<F> field) Unsets any value given for the field and wildcards it so that it matches any value.

Method Detail

get

<F extends OFValueType<F>> F get(MatchField<F> field)
                          throws UnsupportedOperationException

Throws:

UnsupportedOperationException

getMasked

<F extends OFValueType<F>> Masked<F> getMasked(MatchField<F> field)
                                           throws UnsupportedOperationException

Throws:

UnsupportedOperationException

supports

boolean supports(MatchField<?> field)

supportsMasked

boolean supportsMasked(MatchField<?> field)
                       throws UnsupportedOperationException

Throws:

UnsupportedOperationException

isExact

boolean isExact(MatchField<?> field)
                throws UnsupportedOperationException

Throws:

UnsupportedOperationException

isFullyWildcarded

boolean isFullyWildcarded(MatchField<?> field)
                          throws UnsupportedOperationException

Throws:

UnsupportedOperationException

isPartiallyMasked

boolean isPartiallyMasked(MatchField<?> field)
                          throws UnsupportedOperationException

Throws:

UnsupportedOperationException

setExact

<F extends OFValueType<F>> Match.Builder setExact(MatchField<F> field,
                                                F value)
                       throws UnsupportedOperationException

Sets a specific exact value for a field.

Type Parameters:

F - MatchField and value type

Parameters:

field - Match field to set.

value - Value of match field.

Returns:

the Builder instance used.

Throws:

UnsupportedOperationException - If field is not supported.

setMasked

<F extends OFValueType<F>> Match.Builder setMasked(MatchField<F> field,
                                                 F value,
                                                 F mask)
                        throws UnsupportedOperationException

Sets a masked value for a field.

Type Parameters:

F - MatchField, value, and mask type

Parameters:

field - Match field to set.

value - Value of field.

mask - Mask value.

Returns:

the Builder instance used.

Throws:

UnsupportedOperationException - If field is not supported, if field is supported but does not support masking, or if mask structure is not supported.

setMasked

<F extends OFValueType<F>> Match.Builder setMasked(MatchField<F> field,
                                                 Masked<F> valueWithMask)
                        throws UnsupportedOperationException

Sets a masked value for a field.

Type Parameters:

F - MatchField and value with mask type

Parameters:

field - Match field to set.

valueWithMask - Compound Masked object contains the value and the mask.

Returns:

the Builder instance used.

Throws:

UnsupportedOperationException - If field is not supported, if field is supported but does not support masking, or if mask structure is not supported.

wildcard

<F extends OFValueType<F>> Match.Builder wildcard(MatchField<F> field)
                       throws UnsupportedOperationException

Unsets any value given for the field and wildcards it so that it matches any value.

Type Parameters:

F - MatchField type

Parameters:

field - Match field to unset.

Returns:

the Builder instance used.

Throws:

UnsupportedOperationException - If field is not supported.

build

Match build()

Returns the match created by this builder.

Returns:

a Match object.