org.sikuli.api
Enum Target.Ordering

java.lang.Object
  java.lang.Enum<Target.Ordering>
      org.sikuli.api.Target.Ordering

All Implemented Interfaces:

Serializable, Comparable<Target.Ordering>

Enclosing interface:

Target

public static enum Target.Ordering
extends Enum<Target.Ordering>

Defines a set of constants to use to indicate how multiple targets should be ordered by find functions

Author:

tomyeh

Enum Constant Summary

BOTTOM_UP
Ordering from bottom to up

DEFAULT
Default ordering by scores

LEFT_RIGHT
Ordering from left to right

RIGHT_LEFT
Ordering from right to left

TOP_DOWN
Ordering from top to down

Method Summary

static Target.Ordering	valueOf(String name) Returns the enum constant of this type with the specified name.
static Target.Ordering[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEFAULT

public static final Target.Ordering DEFAULT

Default ordering by scores

LEFT_RIGHT

public static final Target.Ordering LEFT_RIGHT

Ordering from left to right

TOP_DOWN

public static final Target.Ordering TOP_DOWN

Ordering from top to down

BOTTOM_UP

public static final Target.Ordering BOTTOM_UP

Ordering from bottom to up

RIGHT_LEFT

public static final Target.Ordering RIGHT_LEFT

Ordering from right to left

Method Detail

values

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

Returns:

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

valueOf

public static Target.Ordering 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