Package org.jsoup.nodes

Class Entities

java.lang.Object

org.jsoup.nodes.Entities

public class Entities
extends Object

HTML entities, and escape routines. Source: W3C HTML named character references.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static enum	Entities.CoreCharset
static enum	Entities.EscapeMode

Field Summary

Fields

Modifier and Type	Field	Description
private static final char[]	codeDelims
(package private) static final int	codepointRadix
private static Document.OutputSettings	DefaultOutput
private static final int	empty
private static final String	emptyName
private static final HashMap<String,String>	multipoints

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Entities()

Method Summary

Modifier and Type	Method	Description
private static void	appendEncoded(Appendable accum, Entities.EscapeMode escapeMode, int codePoint)
private static boolean	canEncode(Entities.CoreCharset charset, char c, CharsetEncoder fallback)
static int	codepointsForName(String name, int[] codepoints)
(package private) static void	escape(Appendable accum, String string, Document.OutputSettings out, boolean inAttribute, boolean normaliseWhite, boolean stripLeadingWhite, boolean trimTrailing)
static String	escape(String string)	HTML escape an input string, using the default settings (UTF-8, base entities).
static String	escape(String string, Document.OutputSettings out)	HTML escape an input string.
static String	getByName(String name)	Get the character(s) represented by the named entity
static boolean	isBaseNamedEntity(String name)	Check if the input is a known named entity in the base entity set.
static boolean	isNamedEntity(String name)	Check if the input is a known named entity
private static void	load(Entities.EscapeMode e, String pointsData, int size)
static String	unescape(String string)	Un-escape an HTML escaped string.
(package private) static String	unescape(String string, boolean strict)	Unescape the input string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

empty

private static final int empty

See Also:

• Constant Field Values

emptyName

private static final String emptyName

See Also:

• Constant Field Values

codepointRadix

static final int codepointRadix

See Also:

• Constant Field Values

codeDelims

private static final char[] codeDelims

multipoints

private static final HashMap<String,String> multipoints

DefaultOutput

private static Document.OutputSettings DefaultOutput

Constructor Details

Entities

private Entities()

Method Details

isNamedEntity

public static boolean isNamedEntity(String name)

Check if the input is a known named entity

Parameters:

name - the possible entity name (e.g. "lt" or "amp")

Returns:

true if a known named entity

isBaseNamedEntity

public static boolean isBaseNamedEntity(String name)

Check if the input is a known named entity in the base entity set.

Parameters:

name - the possible entity name (e.g. "lt" or "amp")

Returns:

true if a known named entity in the base set

See Also:

• isNamedEntity(String)

getByName

public static String getByName(String name)

Get the character(s) represented by the named entity

Parameters:

name - entity (e.g. "lt" or "amp")

Returns:

the string value of the character(s) represented by this entity, or "" if not defined

codepointsForName

public static int codepointsForName(String name,
 int[] codepoints)

escape

public static String escape(String string,
 Document.OutputSettings out)

HTML escape an input string. That is, < is returned as <

Parameters:

string - the un-escaped string to escape

out - the output settings to use

Returns:

the escaped string

escape

public static String escape(String string)

HTML escape an input string, using the default settings (UTF-8, base entities). That is, < is returned as <

Parameters:

string - the un-escaped string to escape

Returns:

the escaped string

escape

static void escape(Appendable accum,
 String string,
 Document.OutputSettings out,
 boolean inAttribute,
 boolean normaliseWhite,
 boolean stripLeadingWhite,
 boolean trimTrailing)
            throws IOException

Throws:

IOException

appendEncoded

private static void appendEncoded(Appendable accum,
 Entities.EscapeMode escapeMode,
 int codePoint)
                           throws IOException

Throws:

IOException

unescape

public static String unescape(String string)

Un-escape an HTML escaped string. That is, < is returned as <.

Parameters:

string - the HTML string to un-escape

Returns:

the unescaped string

unescape

static String unescape(String string,
 boolean strict)

Unescape the input string.

Parameters:

string - to un-HTML-escape

strict - if "strict" (that is, requires trailing ';' char, otherwise that's optional)

Returns:

unescaped string

canEncode

private static boolean canEncode(Entities.CoreCharset charset,
 char c,
 CharsetEncoder fallback)

load

private static void load(Entities.EscapeMode e,
 String pointsData,
 int size)