org.apache.commons.codec

Interface StringEncoder

All Superinterfaces:

Encoder

All Known Implementing Classes:

BCodec, Caverphone, DoubleMetaphone, Metaphone, QCodec, QuotedPrintableCodec, RefinedSoundex, Soundex, URLCodec

public interface StringEncoder
extends Encoder

Encodes a String into a String.

Version:

$Id: StringEncoder.java 651573 2008-04-25 11:11:21Z niallp $

Author:

Apache Software Foundation

Method Summary

Modifier and Type	Method and Description
java.lang.String	encode(java.lang.String pString) Encodes a String and returns a String.

Methods inherited from interface org.apache.commons.codec.Encoder

encode

Method Detail

encode

java.lang.String encode(java.lang.String pString)
                 throws EncoderException

Encodes a String and returns a String.

Parameters:

pString - a String to encode

Returns:

the encoded String

Throws:

EncoderException - thrown if there is an error conidition during the Encoding process.