org.cyclos.model

Enum TextMode

java.lang.Object

java.lang.Enum<TextMode>

org.cyclos.model.TextMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TextMode>

public enum TextMode
extends java.lang.Enum<TextMode>

Determines how textual data is handled

Author:

luis

Enum Constant Summary

Enum Constants

Enum Constant and Description
PLAIN Text is handled as plain: Any "<" is replaced by "< ", effectively escaping all HTML tags.
RAW Text is not sanitized in any way
RICH Text is handled as rich text: It is sanitized for the allowed markup

Method Summary

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

PLAIN

public static final TextMode PLAIN

Text is handled as plain: Any "<" is replaced by "< ", effectively escaping all HTML tags.

RICH

public static final TextMode RICH

Text is handled as rich text: It is sanitized for the allowed markup

RAW

public static final TextMode RAW

Text is not sanitized in any way

Method Detail

values

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

Returns:

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

valueOf

public static TextMode valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null