org.gatein.common.text.CharEncoder Maven / Gradle / Ivy
/******************************************************************************
* JBoss, a division of Red Hat *
* Copyright 2009, Red Hat Middleware, LLC, and individual *
* contributors as indicated by the @authors tag. See the *
* copyright.txt in the distribution for a full listing of *
* individual contributors. *
* *
* This is free software; you can redistribute it and/or modify it *
* under the terms of the GNU Lesser General Public License as *
* published by the Free Software Foundation; either version 2.1 of *
* the License, or (at your option) any later version. *
* *
* This software is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public *
* License along with this software; if not, write to the Free *
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA *
* 02110-1301 USA, or see the FSF site: http://www.fsf.org. *
******************************************************************************/
package org.gatein.common.text;
/**
* Defines an interface for encoding chars.
*
* @author Julien Viet
* @version $Revision: 1.1 $
*/
public interface CharEncoder
{
/**
* @param c the char to encode
* @param writer the writer to use
* @throws IllegalArgumentException if any argument is null
* @throws EncodingException an encoding exception
*/
void encode(char c, CharWriter writer) throws IllegalArgumentException, EncodingException;
/**
* @param chars the chars to encode
* @param off the offset in the char array
* @param len the lenght of chars to encode
* @param writer the writer to use
* @throws IllegalArgumentException if any argument is null or if the bounds not valid in the provided array
* @throws EncodingException an encoding exception
*/
void encode(char[] chars, int off, int len, CharWriter writer) throws IllegalArgumentException, EncodingException;
/**
* @param chars the chars to encode
* @param writer the writer to use
* @throws IllegalArgumentException if any argument is null
* @throws EncodingException an encoding exception
*/
void encode(char[] chars, CharWriter writer) throws IllegalArgumentException, EncodingException;
/**
* @param s the sequence to encode
* @param writer the writer to use
* @throws IllegalArgumentException if any argument is null
* @throws EncodingException an encoding exception
*/
void encode(CharSequence s, CharWriter writer) throws IllegalArgumentException, EncodingException;
/**
* @param string the String to encode
* @return the encoded String
* @throws IllegalArgumentException if the specified String is null
*/
String encode(String string) throws IllegalArgumentException;
}