Package org.ametys.web.renderingcontext

Enum Class RenderingContext

java.lang.Object

java.lang.Enum<RenderingContext>

org.ametys.web.renderingcontext.RenderingContext

All Implemented Interfaces:

Serializable, Comparable<RenderingContext>, java.lang.constant.Constable

public enum RenderingContext
extends Enum<RenderingContext>

CMS current rendering context. It determines URLs, paths, ...

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
BACK	Back-office context
FRONT	Front-office context
PREVIEW	Preview context

Method Summary

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

BACK

public static final RenderingContext BACK

Back-office context

FRONT

public static final RenderingContext FRONT

Front-office context

PREVIEW

public static final RenderingContext PREVIEW

Preview context

Method Details

values

public static RenderingContext[] 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 RenderingContext 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