org.jscsi.target.settings

Class NumericalValueRange

java.lang.Object

org.jscsi.target.settings.NumericalValue

org.jscsi.target.settings.NumericalValueRange

public final class NumericalValueRange
extends NumericalValue

This is a NumericalValue sub-class for representing integer intervals. Each NumericalValueRange is defined by two integers - min and max - the lower and the upper bound of the represented interval.

Author:

Andreas Ergenzinger

Field Summary

Fields inherited from class org.jscsi.target.settings.NumericalValue

BASE_64_CONSTANT_PATTERN, DECIMAL_CONSTANT_PATTERN, HEX_CONSTANT_PATTERN, NUMERICAL_RANGE_PATTERN, SINGLE_CONSTANT_PATTERN

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(int value) Returns true if the passed integer lies completely inside the interval represented by this NumericalValue.
boolean	contains(NumericalValue value) Returns true if the passed NumericalValue lies completely inside the interval represented by this NumericalValueRange.
boolean	contains(NumericalValueRange range) Returns true if the passed NumericalValueRange lies completely inside the interval represented by this NumericalValueRange.
boolean	contains(Object value) Returns true if the passed Integer or NumericalValue lies completely inside the interval represented by this NumericalValue .
boolean	contains(SingleNumericalValue value) Returns true if the passed SingleNumericalValue lies completely inside the interval represented by this NumericalValueRange.
static NumericalValueRange	create(int min, int max) The build method for creating NumericalValueRange objects.
int	getMax() Returns the upper boundary.
int	getMin() Returns the lower boundary.
static NumericalValueRange	parseNumericalValueRange(String value) Parses a NumericalValueRange from a String.
String	toString()

Methods inherited from class org.jscsi.target.settings.NumericalValue

intersect, intersect, parseNumericalValue

Methods inherited from class java.lang.Object

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

Method Detail

create

public static final NumericalValueRange create(int min,
                         int max)

The build method for creating NumericalValueRange objects. The specified min and max parameters are going to be used for initializing the min and max variables of the new NumericalValueRange. Since this only makes sense if min ≤ max, null will be returned if this requirement is violated.

Parameters:

min - the lower bound

max - the upper bound

Returns:

a NumericalValueRange representing the specified interval or null

parseNumericalValueRange

public static final NumericalValueRange parseNumericalValueRange(String value)

Parses a NumericalValueRange from a String. The lower and boundaries must be separated by a '~' character and the the leading integer must not be larger than the trailing one. If these format requirements are violated the method will return null.

Parameters:

value - the String to parse

Returns:

a NumericalValueRange representing the interval in the parsed String or null

getMin

public final int getMin()

Returns the lower boundary.

Returns:

the lower boundary

getMax

public final int getMax()

Returns the upper boundary.

Returns:

the upper boundary

toString

public final String toString()

Overrides:

toString in class Object

contains

public boolean contains(Object value)

Description copied from class: NumericalValue

Returns true if the passed Integer or NumericalValue lies completely inside the interval represented by this NumericalValue . If the parameter is not an Integer or a NumericalValue, the method will return false.

Specified by:

contains in class NumericalValue

Parameters:

value - the Integer or NumericalValue to check

Returns:

true if the value is complete contained, false if it is not

contains

public boolean contains(NumericalValue value)

Returns true if the passed NumericalValue lies completely inside the interval represented by this NumericalValueRange.

Parameters:

value - the NumericalValue to check

Returns:

true if the value is complete contained, false if it is not

contains

public boolean contains(NumericalValueRange range)

Returns true if the passed NumericalValueRange lies completely inside the interval represented by this NumericalValueRange.

Parameters:

range - the NumericalValueRange to check

Returns:

true if the value is complete contained, false if it is not

contains

public boolean contains(SingleNumericalValue value)

Returns true if the passed SingleNumericalValue lies completely inside the interval represented by this NumericalValueRange.

Parameters:

value - the SingleNumericalValue to check

Returns:

true if the value is complete contained, false if it is not

contains

public boolean contains(int value)

Description copied from class: NumericalValue

Returns true if the passed integer lies completely inside the interval represented by this NumericalValue.

Specified by:

contains in class NumericalValue

Parameters:

value - the integer to check

Returns:

true if the value is complete contained, false if it is not