io.vertigo.commons.impl.codec.html

Class AbstractCodec

java.lang.Object

io.vertigo.commons.impl.codec.html.AbstractCodec

All Implemented Interfaces:

Codec<String,String>, Encoder<String,String>

Direct Known Subclasses:

HtmlCodec

public abstract class AbstractCodec
extends Object
implements Codec<String,String>

Encodeur/décodeur. - Encode des char en String, - Décode les String en char, - Il existe un unique caractère d'échappement de type char, - Les caractères A-Z a-z 0-9 ne sont jamais encodés. Dans le cas du HTML le caractère d'échappement est &

Author:

pchretien, npiedeloup

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCodec(char startEscape, char endEscape) Constructeur.

Method Summary

Methods

Modifier and Type	Method and Description
protected String	doDecode(String s) Effectue le décodage.
protected String	doEncode(String s) Effectue l'encodage.
protected abstract String[]	getCharacters() Permet de remplacer des caractères par des mots.
protected abstract boolean	shouldEncode(char c, int index, String stringToEncode) Permet d'optimiser en déterminant si le caractère doit-être encodé

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.vertigo.commons.codec.Codec

decode

Methods inherited from interface io.vertigo.commons.codec.Encoder

encode

Constructor Detail

AbstractCodec

protected AbstractCodec(char startEscape,
             char endEscape)

Constructeur. Génération des tables de remplacement. Contrôle des chaines de remplacement Elles doivent commencer par LE caractère d'échappement et finir par le caractère de terminaison.

Parameters:

startEscape - Caractère d'échappement

endEscape - Caractère de terminaison

Method Detail

shouldEncode

protected abstract boolean shouldEncode(char c,
                   int index,
                   String stringToEncode)

Permet d'optimiser en déterminant si le caractère doit-être encodé

Parameters:

c - Caractère à encoder

index - Index dans la chaine à encoder

stringToEncode - Chaine à encoder

Returns:

Si ce caractère doit être encodé

doEncode

protected final String doEncode(String s)

Effectue l'encodage.

Parameters:

s - Chaine à encoder

Returns:

Chaine encodée

doDecode

protected final String doDecode(String s)

Effectue le décodage.

Parameters:

s - Chaine à décoder

Returns:

Chaine décodée

getCharacters

protected abstract String[] getCharacters()

Permet de remplacer des caractères par des mots.

Returns:

Tableau des éléments à remplacer