Enum Class SiteContextType
- All Implemented Interfaces:
Serializable
,Comparable<SiteContextType>
,java.lang.constant.Constable
A site context type
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionThe site of the context can be any site.The site of the context can be one among the ones returned bySiteContext.getSites()
.The site of the context is the current one.The site of the context can be any site but the current one. -
Method Summary
Modifier and TypeMethodDescriptionGets the client side name of the type of site contextstatic SiteContextType
fromClientSideName
(String clientSideName) Gets aSiteContextType
from its client-side namestatic SiteContextType
Returns the enum constant of this class with the specified name.static SiteContextType[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
CURRENT
The site of the context is the current one. -
AMONG
The site of the context can be one among the ones returned bySiteContext.getSites()
. -
ALL
The site of the context can be any site. -
OTHERS
The site of the context can be any site but the current one.
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
clientSideName
Gets the client side name of the type of site context- Returns:
- the client side name of the type of site context
-
fromClientSideName
Gets aSiteContextType
from its client-side name- Parameters:
clientSideName
- the client-side name- Returns:
- the
SiteContextType
-