org.apache.commons.lang
Class Entities

java.lang.Object
  org.apache.commons.lang.Entities

public class Entities
extends java.lang.Object

Provides HTML and XML entity utilities.

Since:

2.0

Version:

$Id: Entities.java,v 1.1 2008-05-02 15:43:01 gudy Exp $

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

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.
static Entities	XML The set of entities supported by standard XML.

Constructor Summary

Entities()

Method Summary

void	addEntities(java.lang.String[][] entityArray)
void	addEntity(java.lang.String name, int value)
java.lang.String	entityName(int value)
int	entityValue(java.lang.String name)
java.lang.String	escape(java.lang.String str) Escapes the characters in a String.
java.lang.String	unescape(java.lang.String str) Unescapes the entities in a String.

Methods inherited from class java.lang.Object

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

Field Detail

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.

Constructor Detail

Entities

public Entities()

Method Detail

addEntities

public void addEntities(java.lang.String[][] entityArray)

addEntity

public void addEntity(java.lang.String name,
                      int value)

entityName

public java.lang.String entityName(int value)

entityValue

public int entityValue(java.lang.String name)

escape

public java.lang.String escape(java.lang.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.

unescape

public java.lang.String unescape(java.lang.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.