cz.vity.freerapid.plugins.webclient.utils
Class Entities

java.lang.Object
  cz.vity.freerapid.plugins.webclient.utils.Entities

final class Entities
extends Object

Provides HTML and XML entity utilities.

Since:

2.0

Version:

$Id: Entities.java 636641 2008-03-13 06:11:30Z bayard $

Author:

Alexander Day Chaffee, Gary Gregory

See Also:

ISO Entities, HTML 3.2 Character Entities for ISO Latin-1, HTML 4.0 Character entity references, HTML 4.01 Character References, HTML 4.01 Code positions

Nested Class Summary

(package private) static class	Entities.ArrayEntityMap
(package private) static class	Entities.BinaryEntityMap
(package private) static interface	Entities.EntityMap
(package private) static class	Entities.HashEntityMap
(package private) static class	Entities.LookupEntityMap
(package private) static class	Entities.MapIntMap
(package private) static class	Entities.PrimitiveEntityMap
(package private) static class	Entities.TreeEntityMap

Field Summary

static Entities	HTML32 The set of entities supported by HTML 3.2.
static Entities	HTML40 The set of entities supported by HTML 4.0.
(package private) static String[][]	HTML40_ARRAY
(package private) static String[][]	ISO8859_1_ARRAY
(package private) Entities.EntityMap	map
static Entities	XML The set of entities supported by standard XML.

Constructor Summary

Entities()

Method Summary

void	addEntities(String[][] entityArray) Adds entities to this entity.
void	addEntity(String name, int value) Add an entity to this entity.
String	entityName(int value) Returns the name of the entity identified by the specified value.
int	entityValue(String name) Returns the value of the entity identified by the specified name.
String	escape(String str) Escapes the characters in a String.
void	escape(Writer writer, String str) Escapes the characters in the String passed and writes the result to the Writer passed.
(package private) static void	fillWithHtml40Entities(Entities entities) Fills the specified entities instance with HTML 40 entities.
String	unescape(String str) Unescapes the entities in a String.
void	unescape(Writer writer, String str) Unescapes the escaped entities in the String passed and writes the result to the Writer passed.

Methods inherited from class java.lang.Object

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

Field Detail

ISO8859_1_ARRAY

static final String[][] ISO8859_1_ARRAY

HTML40_ARRAY

static final String[][] HTML40_ARRAY

XML

public static final Entities XML

The set of entities supported by standard XML.

HTML32

public static final Entities HTML32

The set of entities supported by HTML 3.2.

HTML40

public static final Entities HTML40

The set of entities supported by HTML 4.0.

map

Entities.EntityMap map

Constructor Detail

Entities

Entities()

Method Detail

fillWithHtml40Entities

static void fillWithHtml40Entities(Entities entities)

Fills the specified entities instance with HTML 40 entities.

Parameters:

entities - the instance to be filled.

addEntities

public void addEntities(String[][] entityArray)

Adds entities to this entity.

Parameters:

entityArray - array of entities to be added

addEntity

public void addEntity(String name,
                      int value)

Add an entity to this entity.

Parameters:

name - name of the entity

value - vale of the entity

entityName

public String entityName(int value)

Returns the name of the entity identified by the specified value.

Parameters:

value - the value to locate

Returns:

entity name associated with the specified value

entityValue

public int entityValue(String name)

Returns the value of the entity identified by the specified name.

Parameters:

name - the name to locate

Returns:

entity value associated with the specified name

escape

public String escape(String str)

Escapes the characters in a String.

For example, if you have called addEntity("foo", 0xA1), escape("¡") will return "&foo;"

Parameters:

str - The String to escape.

Returns:

A new escaped String.

escape

public void escape(Writer writer,
                   String str)
            throws IOException

Escapes the characters in the String passed and writes the result to the Writer passed.

Parameters:

writer - The Writer to write the results of the escaping to. Assumed to be a non-null value.

str - The String to escape. Assumed to be a non-null value.

Throws:

IOException - when Writer passed throws the exception from calls to the Writer.write(int) methods.

See Also:

escape(String), Writer

unescape

public String unescape(String str)

Unescapes the entities in a String.

For example, if you have called addEntity("foo", 0xA1), unescape("&foo;") will return "¡"

Parameters:

str - The String to escape.

Returns:

A new escaped String.

unescape

public void unescape(Writer writer,
                     String str)
              throws IOException

Unescapes the escaped entities in the String passed and writes the result to the Writer passed.

Parameters:

writer - The Writer to write the results to; assumed to be non-null.

str - The source String to unescape; assumed to be non-null.

Throws:

IOException - when Writer passed throws the exception from calls to the Writer.write(int) methods.

See Also:

escape(String), Writer