Interface StringEncoder

All Superinterfaces:
Encoder
All Known Implementing Classes:
BCodec, DoubleMetaphone, Metaphone, QCodec, QuotedPrintableCodec, RefinedSoundex, Soundex, URLCodec

public interface StringEncoder
extends Encoder
Encodes a String into a String.
Version:
$Id: StringEncoder.java,v 1.9 2004/02/29 04:08:31 tobrien Exp $
Author:
Apache Software Foundation
  • Method Summary

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

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

    encode
  • Method Details

    • encode

      String encode​(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.