/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code 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 General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package com.sun.codemodel.internal.util;

import java.io.FilterWriter;

import java.io.IOException;

import java.io.Writer;

/**

 * {@link Writer} that escapes characters that are unsafe

 * as Javadoc comments.

 *

 * Such characters include '<' and '&'.

 *

 * <p>

 * Note that this class doesn't escape other Unicode characters

 * that means "love") can be considered as unsafe because

 * javac with English Windows cannot accept this character in the

 * source code.

 *

 * <p>

 * If the application needs to escape such characters as well, then

 * they are on their own.

 *

 * @author

 *      Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)

 */

public class JavadocEscapeWriter extends FilterWriter {

    public JavadocEscapeWriter( Writer next ) {

        super(next);

    }

    public void write(int ch) throws IOException {

        if(ch=='<')

            out.write("<");

        else

        if(ch=='&')

            out.write("&");

        else

        if(ch=='>')

            out.write(">");

        else

            out.write(ch);

    }

    public void write(char[] buf, int off, int len) throws IOException {

        for( int i=0; i<len; i++ )

            write(buf[off+i]);

    }

    public void write(char[] buf) throws IOException {

        write(buf,0,buf.length);

    }

    public void write(String buf, int off, int len) throws IOException {

        write( buf.toCharArray(), off, len );

    }

    public void write(String buf) throws IOException {

        write( buf.toCharArray(), 0, buf.length() );

    }

}