org.xwiki.gwt.dom.client
Enum RangeCompare

java.lang.Object
  java.lang.Enum<RangeCompare>
      org.xwiki.gwt.dom.client.RangeCompare

All Implemented Interfaces:

Serializable, Comparable<RangeCompare>

public enum RangeCompare
extends Enum<RangeCompare>

Passed as a parameter to the compareBoundaryPoints method.

Version:

$Id: 4b78d3e09cd057cf9a9ab6f88fc798c0c3d607ff $

Enum Constant Summary

END_TO_END
Compare end boundary-point of sourceRange to end boundary-point of Range on which compareBoundaryPoints is invoked.

END_TO_START
Compare end boundary-point of sourceRange to start boundary-point of Range on which compareBoundaryPoints is invoked.

START_TO_END
Compare start boundary-point of sourceRange to end boundary-point of Range on which compareBoundaryPoints is invoked.

START_TO_START
Compare start boundary-point of sourceRange to start boundary-point of Range on which compareBoundaryPoints is invoked.

Method Summary

RangeCompare	reverse()
String	toString()
static RangeCompare	valueOf(boolean firstEndPoint, boolean secondEndPoint)
static RangeCompare	valueOf(String name) Returns the enum constant of this type with the specified name.
static RangeCompare[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

START_TO_START

public static final RangeCompare START_TO_START

Compare start boundary-point of sourceRange to start boundary-point of Range on which compareBoundaryPoints is invoked.

START_TO_END

public static final RangeCompare START_TO_END

Compare start boundary-point of sourceRange to end boundary-point of Range on which compareBoundaryPoints is invoked.

END_TO_END

public static final RangeCompare END_TO_END

Compare end boundary-point of sourceRange to end boundary-point of Range on which compareBoundaryPoints is invoked.

END_TO_START

public static final RangeCompare END_TO_START

Compare end boundary-point of sourceRange to start boundary-point of Range on which compareBoundaryPoints is invoked.

Method Detail

values

public static RangeCompare[] 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 (RangeCompare c : RangeCompare.values())
    System.out.println(c);

Returns:

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

valueOf

public static RangeCompare 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

toString

public String toString()

Overrides:

toString in class Enum<RangeCompare>

reverse

public RangeCompare reverse()

Returns:

The reverse the end points that are compared.

valueOf

public static RangeCompare valueOf(boolean firstEndPoint,
                                   boolean secondEndPoint)

Parameters:

firstEndPoint - true for START and false for END.

secondEndPoint - true for START and false for END.

Returns:

the value associated with the specified end points.