org.gatein.common.text

Class EntityEncoder

java.lang.Object

org.gatein.common.text.AbstractCharEncoder

org.gatein.common.text.EntityEncoder

All Implemented Interfaces:

CharEncoder

public class EntityEncoder
extends AbstractCharEncoder

This encoder performs lookup for converting a char to its HTML entity representation.

Version:

$Revision: 630 $

Author:

Julien Viet

Field Summary

Fields

Modifier and Type	Field and Description
static EntityEncoder	BASIC All HTML entities except the HTML chars which are used to do HTML itself.
static EntityEncoder	FULL All HTML entities.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EntityEncoder()

Method Summary

Methods

Modifier and Type	Method and Description
void	encode(char c, CharWriter writer)
String	lookup(char c) Returns null if no entity is found or return the converted entity.
protected void	put(int c, String entity)
protected void	remove(int c)
int	reverse(String s) Returns the char related to the provided string.
void	safeEncode(char[] chars, int off, int len, CharWriter writer)

Methods inherited from class org.gatein.common.text.AbstractCharEncoder

encode, encode, encode, encode

Methods inherited from class java.lang.Object

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

Field Detail

FULL

public static final EntityEncoder FULL

All HTML entities.

BASIC

public static final EntityEncoder BASIC

All HTML entities except the HTML chars which are used to do HTML itself.

Constructor Detail

EntityEncoder

protected EntityEncoder()

Method Detail

encode

public void encode(char c,
          CharWriter writer)
            throws EncodingException

Specified by:

encode in interface CharEncoder

Overrides:

encode in class AbstractCharEncoder

Parameters:

c - the char to encode

writer - the writer to use

Throws:

EncodingException - an encoding exception

safeEncode

public void safeEncode(char[] chars,
              int off,
              int len,
              CharWriter writer)
                throws EncodingException

Specified by:

safeEncode in class AbstractCharEncoder

Throws:

EncodingException

put

protected final void put(int c,
       String entity)

remove

protected final void remove(int c)

lookup

public final String lookup(char c)

Returns null if no entity is found or return the converted entity.

Parameters:

c - the char to encode

Returns:

the corresponding encoded string or null

reverse

public final int reverse(String s)

Returns the char related to the provided string. For instance, ccedil as input returns ç (int 231).

Parameters:

s - the string to be reversed into the character

Returns:

the int code for the given string or -1, if it wasn't found