oracle.adf.view.rich.render

Enum ClientComponent.Type

java.lang.Object

java.lang.Enum<ClientComponent.Type>

oracle.adf.view.rich.render.ClientComponent.Type

All Implemented Interfaces:

Serializable, Comparable<ClientComponent.Type>

Enclosing class:

ClientComponent

public static enum ClientComponent.Type
extends Enum<ClientComponent.Type>

Possible client component types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CREATE_WITH_ALL_ATTRS Send all attributes.
CREATE_WITH_REQUIRED_ATTRS Only send required attributes, but always send a component.
SKIP Do not send any client component, no matter what attributes are present unless the client components are being forced on
SKIP_ALWAYS Never send any client component under any circumstances
SKIP_UNLESS_REQUIRED_ATTRS Only send if there are required attributes (and only send the required attributes).

Method Summary

Modifier and Type	Method and Description
static ClientComponent.Type	max(ClientComponent.Type type1, ClientComponent.Type type2) Returns the maximum attribute retention of two Types.
boolean	skipClientComponent() Convenience function to return whether output of a ClientComponent with this Type should generally be skipped.
static ClientComponent.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static ClientComponent.Type[]	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

SKIP_ALWAYS

public static final ClientComponent.Type SKIP_ALWAYS

Never send any client component under any circumstances

SKIP

public static final ClientComponent.Type SKIP

Do not send any client component, no matter what attributes are present unless the client components are being forced on

SKIP_UNLESS_REQUIRED_ATTRS

public static final ClientComponent.Type SKIP_UNLESS_REQUIRED_ATTRS

Only send if there are required attributes (and only send the required attributes).

CREATE_WITH_REQUIRED_ATTRS

public static final ClientComponent.Type CREATE_WITH_REQUIRED_ATTRS

Only send required attributes, but always send a component.

CREATE_WITH_ALL_ATTRS

public static final ClientComponent.Type CREATE_WITH_ALL_ATTRS

Send all attributes. This should almost never be used by clients. CREATE_WITH_REQUIRED_ATTRS is virtually always the more efficient and better choice.

Method Detail

values

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

Returns:

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

valueOf

public static ClientComponent.Type 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

skipClientComponent

public boolean skipClientComponent()

Convenience function to return whether output of a ClientComponent with this Type should generally be skipped.

Returns:

true if out of a ClientComponent with this type should be skipped

max

public static ClientComponent.Type max(ClientComponent.Type type1,
                                       ClientComponent.Type type2)

Returns the maximum attribute retention of two Types. For example Type.CREATE_WITH_ALL_ATTRS will create a client component with at least as many client attributes as Type.CREATE_WITH_REQUIRED_ATTRS, so type.max(Type.CREATE_WITH_ALL_ATTRS, Type.CREATE_WITH_REQUIRED_ATTRS) returns Type.CREATE_WITH_ALL_ATTRS.

Parameters:

type1 - the first type to compare against

type2 - the second type to compare against.

Returns:

the maximum attribute retention of two Types