com.attachmate.cicsbridge
Enum FindFlag

java.lang.Object
  java.lang.Enum<FindFlag>
      com.attachmate.cicsbridge.FindFlag

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FindFlag>

public enum FindFlag
extends java.lang.Enum<FindFlag>

Flags to use in the FindString method on the BridgeAPI

Enum Constant Summary

BACKWARD
The findString method searches backward.

FIELD_ONLY
The findString method searches only in the field that contains the specified row and column.

IGNORE_CASE
The findString method ignores case when searching for a string.

WRAP
The findString method wraps to the beginning of the screen or field after reaching the end.

Method Summary

static FindFlag	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FindFlag[]	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

WRAP

public static final FindFlag WRAP

The findString method wraps to the beginning of the screen or field after reaching the end.

BACKWARD

public static final FindFlag BACKWARD

The findString method searches backward.

FIELD_ONLY

public static final FindFlag FIELD_ONLY

The findString method searches only in the field that contains the specified row and column. All other flags apply only within the field. The search begins at the point in the field specified by the inRow and inColumn parameters. The outRow and outColumn parameters contain the position on the screen where the string is found, or zero if the string is not found.

IGNORE_CASE

public static final FindFlag IGNORE_CASE

The findString method ignores case when searching for a string.

Method Detail

values

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

Returns:

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

valueOf

public static FindFlag valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null