1. /*
  2. * Copyright 2001-2004 The Apache Software Foundation.
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. package org.apache.commons.codec;
  17. /**
  18. * Encodes a String into a String.
  19. *
  20. * @author Apache Software Foundation
  21. * @version $Id: StringEncoder.java,v 1.9 2004/02/29 04:08:31 tobrien Exp $
  22. */
  23. public interface StringEncoder extends Encoder {
  24. /**
  25. * Encodes a String and returns a String.
  26. *
  27. * @param pString a String to encode
  28. *
  29. * @return the encoded String
  30. *
  31. * @throws EncoderException thrown if there is
  32. * an error conidition during the Encoding process.
  33. */
  34. String encode(String pString) throws EncoderException;
  35. }