com.ibm.openpages.api.resource

Enum IncludeContainees

java.lang.Object

java.lang.Enum<IncludeContainees>

com.ibm.openpages.api.resource.IncludeContainees

All Implemented Interfaces:

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

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

Represents valid values for including containees.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTH
FOLDER
GRCOBJECT

Method Summary

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

FOLDER

public static final IncludeContainees FOLDER

GRCOBJECT

public static final IncludeContainees GRCOBJECT

BOTH

public static final IncludeContainees BOTH

Method Detail

values

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

Returns:

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

valueOf

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