Package de.pdark.decentxml

Class EntityResolver

java.lang.Object

de.pdark.decentxml.EntityResolver

Direct Known Subclasses:

DocTypeEntityResolver, HTMLEntityResolver

public class EntityResolver
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static String	AMP_ESCAPE	Escape for "&" (ampersand)
static String	APOS_ESCAPE	Escape for "'" (single quote or apostrophe)
static String	GT_ESCAPE	Escape for ">" (greater than)
static String	LT_ESCAPE	Escape for "<" (less than)
static String	QUOT_ESCAPE	Escape for '"' (double quote)
protected Map<String,String>	resolveMap

Constructor Summary

Constructors

Constructor	Description
EntityResolver()
EntityResolver(EntityResolver parent)

Method Summary

Modifier and Type	Method	Description
void	add(String name, String replacementText)	Add a new entity
void	clear()	Remove all definitions from the map except the standard XML entities (<, >, ...)
String	encode(String input)	Replace text in a string with entity references
String	expand(String entity)	Expand an entity reference.
int	expandNumericEntity(String entity)	Returns the character value of a numeric entity.
CharValidator	getCharValidator()
EntityResolver	getParent()
boolean	isDefined(String name)	Check if an entity is defined.
String	resolve(String name)	Resolve an entity reference.
EntityResolver	setCharValidator(CharValidator charValidator)
protected String	stripName(String name)
void	validateEntity(String entity)

Methods inherited from class java.lang.Object

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

Field Detail

AMP_ESCAPE

public static final String AMP_ESCAPE

Escape for "&" (ampersand)

See Also:

Constant Field Values

LT_ESCAPE

public static final String LT_ESCAPE

Escape for "<" (less than)

See Also:

Constant Field Values

GT_ESCAPE

public static final String GT_ESCAPE

Escape for ">" (greater than)

See Also:

Constant Field Values

QUOT_ESCAPE

public static final String QUOT_ESCAPE

Escape for '"' (double quote)

See Also:

Constant Field Values

APOS_ESCAPE

public static final String APOS_ESCAPE

Escape for "'" (single quote or apostrophe)

See Also:

Constant Field Values

resolveMap

protected Map<String,String> resolveMap

Constructor Detail

EntityResolver

public EntityResolver()

EntityResolver

public EntityResolver(EntityResolver parent)

Method Detail

getParent

public EntityResolver getParent()

getCharValidator

public CharValidator getCharValidator()

setCharValidator

public EntityResolver setCharValidator(CharValidator charValidator)

clear

public void clear()

Remove all definitions from the map except the standard XML entities (&lt;, &gt;, ...)

add

public void add(String name,
                String replacementText)

Add a new entity

Parameters:

name - for example "lt"

replacementText - for example "<"

isDefined

public boolean isDefined(String name)

Check if an entity is defined.

Parameters:

name - The name of an entity ("lt" or "<").

Returns:

the value of the entity or null

resolve

public String resolve(String name)

Resolve an entity reference.

This returns the text stored for this entity reference. No recursive expansion takes place.

Parameters:

name - The name of an entity ("lt" or "<").

Returns:

the value of the entity or null

stripName

protected String stripName(String name)

expand

public String expand(String entity)

Expand an entity reference. If the reference is unknown, the method will null.

Valid inputs are entity names or entity references (i.e. it will work with "lt" and "<")

encode

public String encode(String input)

Replace text in a string with entity references

expandNumericEntity

public int expandNumericEntity(String entity)

Returns the character value of a numeric entity.

NOTE: This method returns a "code point", not a character. One "code point" can map to one or two Java characters!

Throws:

IllegalArgumentException - if the numeric entity has the wrong format, or the value is too low or high.

validateEntity

public void validateEntity(String entity)