com.rapidclipse.framework.server.webapi.visibility

Enum VisibilityState

java.lang.Object

java.lang.Enum<VisibilityState>

com.rapidclipse.framework.server.webapi.visibility.VisibilityState

All Implemented Interfaces:

Serializable, Comparable<VisibilityState>

public enum VisibilityState
extends Enum<VisibilityState>

The visibility state of an application. If the user can see the application its visibility state is visible.

Since:

10.02.00

Author:

XDEV Software

Enum Constant Summary

Enum Constants

Enum Constant and Description
hidden The user can not see the application.
prerender This is usually set when the application is first loaded.
unloaded This can be set when the application is being unloaded.
visible The user can see the application.

Method Summary

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

visible

public static final VisibilityState visible

The user can see the application.

hidden

public static final VisibilityState hidden

The user can not see the application.

prerender

public static final VisibilityState prerender

This is usually set when the application is first loaded. The state will never change to this value afterwards.

unloaded

public static final VisibilityState unloaded

This can be set when the application is being unloaded.

Method Detail

values

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

Returns:

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

valueOf

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