com.xmlmind.xml.load

Class CharEntities

java.lang.Object

com.xmlmind.xml.load.CharEntities

public final class CharEntities
extends Object

A map containing character entities defined in a DTD (example:  ).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CharEntities.Entry Associates a character to its entity name.
static class	CharEntities.EntryComparator

Field Summary

Fields

Modifier and Type	Field and Description
static CharEntities.EntryComparator	COMPARE_BY_ENTITY_NAME

Constructor Summary

Constructors

Constructor and Description
CharEntities() Constructs an empty map.

Method Summary

Modifier and Type	Method and Description
void	add(String name, char c) Adds an entry for specified entity name and character.
CharEntities.Entry[]	getAll() Returns all entries contained in this map.
int	getChar(String name) Returns the character corresponding to specified entity name.
static CharEntities	getDocBookInstance() Returns the map containing all characters entities defined in the DocBook V4.5 DTD.
static CharEntities	getHTMLInstance() Returns the map containing all characters entities defined in the XHTML 1.0 Transitional DTD.
String	getName(char c) Returns the entity name of specified character.
static void	load(URL url, CharEntities charEntities) Loads character entities defined in the specified Java properties file.
int	size() Returns the number of entries contained in this map.

Methods inherited from class java.lang.Object

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

Field Detail

COMPARE_BY_ENTITY_NAME

public static final CharEntities.EntryComparator COMPARE_BY_ENTITY_NAME

Constructor Detail

CharEntities

public CharEntities()

Constructs an empty map.

Method Detail

add

public void add(String name,
                char c)

Adds an entry for specified entity name and character.

See Also:

CharEntities.Entry

getName

public String getName(char c)

Returns the entity name of specified character. Returns null if specified character is not found in this map.

getChar

public int getChar(String name)

Returns the character corresponding to specified entity name. Returns -1 if specified entity name is not found in this map.

size

public int size()

Returns the number of entries contained in this map.

getAll

public CharEntities.Entry[] getAll()

Returns all entries contained in this map.

getDocBookInstance

public static CharEntities getDocBookInstance()

Returns the map containing all characters entities defined in the DocBook V4.5 DTD.

The returned map should not be modified.

load

public static void load(URL url,
                        CharEntities charEntities)
                 throws IOException

Loads character entities defined in the specified Java properties file.

Parameters:

url - URL of a Java properties file containing the definitions of character entities (example: aleph=ℵ)

charEntities - the character entities found in the above file are added to this set

Throws:

IOException - if there is an I/O problem

getHTMLInstance

public static CharEntities getHTMLInstance()

Returns the map containing all characters entities defined in the XHTML 1.0 Transitional DTD.

The returned map should not be modified.