Package de.xima.fc.utils.range

Enum PointRangeRelation

java.lang.Object

java.lang.Enum<PointRangeRelation>

de.xima.fc.utils.range.PointRangeRelation

All Implemented Interfaces:

Serializable, Comparable<PointRangeRelation>

public enum PointRangeRelation
extends Enum<PointRangeRelation>

Enumeration with the possible relationships between a range and a point.

Since:

8.0.0

Author:

XIMA MEDIA GmbH

Enum Constant Summary

Enum Constants

Enum Constant	Description
EQUALS_LEFT_ENDPOINT	The point is equal to the left endpoint of the range (implies that the range is closed on the left endpoint).
EQUALS_RIGHT_ENDPOINT	The point is equal to the right endpoint of the range (implies that the range is closed on the right endpoint).
INSIDE_RANGE	The point is contained in the range.
LEFT_OF_RANGE	The point lies to the left of the range.
RIGHT_OF_RANGE	The point lies to the right of range.

Method Summary

Modifier and Type	Method	Description
static PointRangeRelation	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PointRangeRelation[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSIDE_RANGE

public static final PointRangeRelation INSIDE_RANGE

The point is contained in the range.

LEFT_OF_RANGE

public static final PointRangeRelation LEFT_OF_RANGE

The point lies to the left of the range.

RIGHT_OF_RANGE

public static final PointRangeRelation RIGHT_OF_RANGE

The point lies to the right of range.

EQUALS_LEFT_ENDPOINT

public static final PointRangeRelation EQUALS_LEFT_ENDPOINT

The point is equal to the left endpoint of the range (implies that the range is closed on the left endpoint).

EQUALS_RIGHT_ENDPOINT

public static final PointRangeRelation EQUALS_RIGHT_ENDPOINT

The point is equal to the right endpoint of the range (implies that the range is closed on the right endpoint).

Method Detail

values

public static PointRangeRelation[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PointRangeRelation c : PointRangeRelation.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PointRangeRelation valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null