Package de.espirit.firstspirit.module.descriptor

Enum Class ComponentDescriptor.Scope

java.lang.Object

java.lang.Enum<ComponentDescriptor.Scope>

de.espirit.firstspirit.module.descriptor.ComponentDescriptor.Scope

All Implemented Interfaces:

Serializable, Comparable<ComponentDescriptor.Scope>, Constable

Enclosing interface:

ComponentDescriptor

public static enum ComponentDescriptor.Scope
extends Enum<ComponentDescriptor.Scope>

The scope describes the place where the component is available: server-wide, project-local or web-local.

Since:

4.1

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
PROJECT	Scope for components project locally available.
SERVER	Scope for server-wide available components.
WEB	Scope for web-local available components.

Method Summary

Modifier and Type	Method	Description
static ComponentDescriptor.Scope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ComponentDescriptor.Scope[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SERVER

public static final ComponentDescriptor.Scope SERVER

Scope for server-wide available components.

Since:

4.1

PROJECT

public static final ComponentDescriptor.Scope PROJECT

Scope for components project locally available.

Since:

4.1

WEB

public static final ComponentDescriptor.Scope WEB

Scope for web-local available components.

Since:

4.1

Method Details

values

public static ComponentDescriptor.Scope[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ComponentDescriptor.Scope valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null