Package org.unbescape.html

Enum HtmlEscapeType

Object

Enum<HtmlEscapeType>

org.unbescape.html.HtmlEscapeType

All Implemented Interfaces:

java.io.Serializable, Comparable<HtmlEscapeType>

public enum HtmlEscapeType
extends Enum<HtmlEscapeType>

Types of escape operations to be performed on HTML text:

• HTML4_NAMED_REFERENCES_DEFAULT_TO_DECIMAL: Replace escaped characters with HTML 4 Named Character References (Character Entity References) whenever possible (depending on the specified HtmlEscapeLevel), and default to using Decimal Character References for escaped characters that do not have an associated NCR.
• HTML4_NAMED_REFERENCES_DEFAULT_TO_HEXA: Replace escaped characters with HTML 4 Named Character References (Character Entity References) whenever possible (depending on the specified HtmlEscapeLevel), and default to using Hexadecimal Character References for escaped characters that do not have an associated NCR.
• HTML5_NAMED_REFERENCES_DEFAULT_TO_DECIMAL: Replace escaped characters with HTML5 Named Character References whenever possible (depending on the specified HtmlEscapeLevel), and default to using Decimal Character References for escaped characters that do not have an associated NCR.
• HTML5_NAMED_REFERENCES_DEFAULT_TO_HEXA: Replace escaped characters with HTML5 Named Character References whenever possible (depending on the specified HtmlEscapeLevel), and default to using Hexadecimal Character References for escaped characters that do not have an associated NCR.
• DECIMAL_REFERENCES: Replace escaped characters with Decimal Character References (will never use NCRs).
• HEXADECIMAL_REFERENCES: Replace escaped characters with Hexadecimal Character References (will never use NCRs).

For further information, see the Glossary and the References sections at the documentation for the HtmlEscape class.

Since:

1.0.0

Author:

Daniel Fernández

Enum Constant Summary

Enum Constants

Enum Constant	Description
DECIMAL_REFERENCES	Always use Decimal Character References (no NCRs will be used).
HEXADECIMAL_REFERENCES	Always use Hexadecimal Character References (no NCRs will be used).
HTML4_NAMED_REFERENCES_DEFAULT_TO_DECIMAL	Use HTML 4 NCRs if possible, default to Decimal Character References.
HTML4_NAMED_REFERENCES_DEFAULT_TO_HEXA	Use HTML 4 NCRs if possible, default to Hexadecimal Character References.
HTML5_NAMED_REFERENCES_DEFAULT_TO_DECIMAL	Use HTML5 NCRs if possible, default to Decimal Character References.
HTML5_NAMED_REFERENCES_DEFAULT_TO_HEXA	Use HTML5 NCRs if possible, default to Hexadecimal Character References.

Method Summary

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

HTML4_NAMED_REFERENCES_DEFAULT_TO_DECIMAL

public static final HtmlEscapeType HTML4_NAMED_REFERENCES_DEFAULT_TO_DECIMAL

Use HTML 4 NCRs if possible, default to Decimal Character References.

HTML4_NAMED_REFERENCES_DEFAULT_TO_HEXA

public static final HtmlEscapeType HTML4_NAMED_REFERENCES_DEFAULT_TO_HEXA

Use HTML 4 NCRs if possible, default to Hexadecimal Character References.

HTML5_NAMED_REFERENCES_DEFAULT_TO_DECIMAL

public static final HtmlEscapeType HTML5_NAMED_REFERENCES_DEFAULT_TO_DECIMAL

Use HTML5 NCRs if possible, default to Decimal Character References.

HTML5_NAMED_REFERENCES_DEFAULT_TO_HEXA

public static final HtmlEscapeType HTML5_NAMED_REFERENCES_DEFAULT_TO_HEXA

Use HTML5 NCRs if possible, default to Hexadecimal Character References.

DECIMAL_REFERENCES

public static final HtmlEscapeType DECIMAL_REFERENCES

Always use Decimal Character References (no NCRs will be used).

HEXADECIMAL_REFERENCES

public static final HtmlEscapeType HEXADECIMAL_REFERENCES

Always use Hexadecimal Character References (no NCRs will be used).

Method Detail

values

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

Returns:

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

valueOf

public static HtmlEscapeType 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 name

NullPointerException - if the argument is null