org.opendaylight.vtn.manager.internal.util.flow.match

Class VTNPortRange

java.lang.Object

org.opendaylight.vtn.manager.internal.util.flow.match.VTNPortRange

public final class VTNPortRange
extends Object

VTNPortRange describes the range of IP transport layer protocol such as TCP.

Note that this class is not synchronized.

Constructor Summary

Constructors

Constructor and Description
VTNPortRange(int port) Construct a new instance which specifies the given port number.
VTNPortRange(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber port) Construct a new instance which specifies the given port number explicitly.
VTNPortRange(VtnPortRange range) Construct a new instance from the given VtnPortRange instance.

Method Summary

Modifier and Type	Method and Description
static VTNPortRange	create(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber port) Construct a new instance which specifies the given port number explicitly.
static VTNPortRange	create(VtnPortRange range) Construct a new instance from the given VtnPortRange instance.
boolean	equals(Object o) Determine whether the given object is identical to this object.
Integer	getPortFrom() Return the minimum (inclusive) value in the range of port numbers to match against packets.
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber	getPortNumberFrom() Return the minimum (inclusive) value in the range of port numbers to match against packets.
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber	getPortNumberTo() Return the maximum (inclusive) value in the range of port numbers to match against packets.
Integer	getPortTo() Return the maximum (inclusive) value in the range of port numbers to match against packets.
int	hashCode() Return the hash code of this object.
boolean	match(int port) Determine whether the given port number is contained by the port range specified by this instance.
void	setConditionKey(StringBuilder builder) Store strings used to construct flow condition key.
void	verify() Verify the contents of this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

VTNPortRange

public VTNPortRange(int port)
             throws RpcException

Construct a new instance which specifies the given port number.

Parameters:

port - The port number.

Throws:

RpcException - An invalid port number is specified.

VTNPortRange

public VTNPortRange(VtnPortRange range)
             throws RpcException

Construct a new instance from the given VtnPortRange instance.

Parameters:

range - A VtnPortRange instance.

Throws:

NullPointerException - range is null.

RpcException - range contains invalid value.

VTNPortRange

public VTNPortRange(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber port)
             throws RpcException

Construct a new instance which specifies the given port number explicitly.

Parameters:

port - A PortNumber instance.

Throws:

RpcException - port contains invalid value.

Method Detail

create

public static VTNPortRange create(VtnPortRange range)
                           throws RpcException

Construct a new instance from the given VtnPortRange instance.

Parameters:

range - A VtnPortRange instance.

Returns:

A VTNPortRange instance if pmatch is not null. Otherwise null.

Throws:

RpcException - range contains invalid value.

create

public static VTNPortRange create(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber port)
                           throws RpcException

Construct a new instance which specifies the given port number explicitly.

Parameters:

port - A PortNumber instance.

Returns:

A VTNPortRange instance if port is not null. Otherwise null.

Throws:

RpcException - port contains invalid value.

getPortFrom

public Integer getPortFrom()

Return the minimum (inclusive) value in the range of port numbers to match against packets.

Returns:

The minimum value in the range of port numbers.

getPortTo

public Integer getPortTo()

Return the maximum (inclusive) value in the range of port numbers to match against packets.

Returns:

The maximum value in the range of port numbers.

getPortNumberFrom

public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getPortNumberFrom()

Return the minimum (inclusive) value in the range of port numbers to match against packets.

Returns:

A PortNumber instance that contains the minimum value in the range of port numbers.

getPortNumberTo

public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getPortNumberTo()

Return the maximum (inclusive) value in the range of port numbers to match against packets.

Returns:

A PortNumber instance that contains the maximum value in the range of port numbers.

match

public boolean match(int port)

Determine whether the given port number is contained by the port range specified by this instance.

Parameters:

port - A port number.

Returns:

true only if the given port number is contained by the port range.

setConditionKey

public void setConditionKey(StringBuilder builder)

Store strings used to construct flow condition key.

Parameters:

builder - A StringBuilder instance that contains strings used to construct flow condition key.

verify

public void verify()
            throws RpcException

Verify the contents of this instance.

Throws:

RpcException - Verification failed.

equals

public boolean equals(Object o)

Determine whether the given object is identical to this object.

Overrides:

equals in class Object

Parameters:

o - An object to be compared.

Returns:

true if identical. Otherwise false.

hashCode

public int hashCode()

Return the hash code of this object.

Overrides:

hashCode in class Object

Returns:

The hash code.