Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.commons.codec
Interface StringEncoder

All Superinterfaces:
  Encoder

All Known Implementing Classes:
  AbstractCaverphone, BCodec, BeiderMorseEncoder, Caverphone, Caverphone1, Caverphone2, ColognePhonetic, DoubleMetaphone, Metaphone, QCodec, QuotedPrintableCodec, RefinedSoundex, Soundex, URLCodec

    public interface StringEncoder

extends Encoder

Defines common encoding methods for String encoders.

Version:
  $Id: StringEncoder.java 1170351 2011-09-13 21:09:09Z ggregory $
Author:
  Apache Software Foundation

Method Summary
`String` | `encode(String source)` Encodes a String and returns a String.

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

Method Detail

### encode

    String encode(String source)
                  throws EncoderException

  Encodes a String and returns a String.

  Parameters:
    `source` - the String to encode
  Returns:
    the encoded String
  Throws:
    `EncoderException` - thrown if there is an error condition during the encoding process.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2002-2011 The Apache Software Foundation. All Rights Reserved.