Package burp.api.montoya.utilities

Enum Class HtmlEncoding

java.lang.Object

java.lang.Enum<HtmlEncoding>

burp.api.montoya.utilities.HtmlEncoding

All Implemented Interfaces:

Serializable, Comparable<HtmlEncoding>, Constable

public enum HtmlEncoding
extends Enum<HtmlEncoding>

This enum defines HTML encodings.

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
ALL_CHARACTERS	Encode HTML special characters as per STANDARD, encode all other characters as decimal entities.
ALL_CHARACTERS_DECIMAL	Encode all characters as decimal entities.
ALL_CHARACTERS_HEX	Encode all characters as hex entities.
STANDARD	Encode only HTML special characters.

Method Summary

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

STANDARD

public static final HtmlEncoding STANDARD

Encode only HTML special characters.

ALL_CHARACTERS

public static final HtmlEncoding ALL_CHARACTERS

Encode HTML special characters as per STANDARD, encode all other characters as decimal entities.

ALL_CHARACTERS_DECIMAL

public static final HtmlEncoding ALL_CHARACTERS_DECIMAL

Encode all characters as decimal entities.

ALL_CHARACTERS_HEX

public static final HtmlEncoding ALL_CHARACTERS_HEX

Encode all characters as hex entities.

Method Details

values

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