Package org.appng.api
Enum Scope
- java.lang.Object
-
- java.lang.Enum<Scope>
-
- org.appng.api.Scope
-
- All Implemented Interfaces:
Serializable
,Comparable<Scope>
public enum Scope extends Enum<Scope>
Enum type defining the possible scopes of anEnvironment
-attribute.- Author:
- Matthias Müller
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
forSite(String host)
static Scope
valueOf(String name)
Returns the enum constant of this type with the specified name.static Scope[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Method Detail
-
values
public static Scope[] 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 (Scope c : Scope.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static Scope 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 nameNullPointerException
- if the argument is null
-
forSite
public String forSite(String host)
- Parameters:
host
- the host of theSite
to get the name for- Returns:
- a String used in order to identify an
Environment
for aSite
- Throws:
IllegalArgumentException
- if this scope not equalsSITE
-
-