Quadcap Bug Database

com/quadcap/app/bugdb/HtmlWriter.java

Go to the documentation of this file.

package com.quadcap.app.bugdb;

/* Copyright 1999 - 2003 Quadcap Software.  All rights reserved.
 *
 * This software is distributed under the Quadcap Free Software License.
 * This software may be used or modified for any purpose, personal or
 * commercial.  Open Source redistributions are permitted.  Commercial
 * redistribution of larger works derived from, or works which bundle
 * this software requires a "Commercial Redistribution License"; see
 * http://www.quadcap.com/purchase.
 *
 * Redistributions qualify as "Open Source" under  one of the following terms:
 *   
 *    Redistributions are made at no charge beyond the reasonable cost of
 *    materials and delivery.
 *
 *    Redistributions are accompanied by a copy of the Source Code or by an
 *    irrevocable offer to provide a copy of the Source Code for up to three
 *    years at the cost of materials and delivery.  Such redistributions
 *    must allow further use, modification, and redistribution of the Source
 *    Code under substantially the same terms as this license.
 *
 * Redistributions of source code must retain the copyright notices as they
 * appear in each source code file, these license terms, and the
 * disclaimer/limitation of liability set forth as paragraph 6 below.
 *
 * Redistributions in binary form must reproduce this Copyright Notice,
 * these license terms, and the disclaimer/limitation of liability set
 * forth as paragraph 6 below, in the documentation and/or other materials
 * provided with the distribution.
 *
 * The Software is provided on an "AS IS" basis.  No warranty is
 * provided that the Software is free of defects, or fit for a
 * particular purpose.  
 *
 * Limitation of Liability. Quadcap Software shall not be liable
 * for any damages suffered by the Licensee or any third party resulting
 * from use of the Software.
 */

import java.io.IOException;
import java.io.Writer;

/**
 * Perform HTML encoding, replacing HTML markup symbols with their entity
 * representation.
 *
 * @author Stan Bailes
 */
public class HtmlWriter extends Writer {
    Writer                      os;
    static final char[] ampLT = {
        '&', 'l', 't', ';'
    };
    static final char[] ampGT = {
        '&', 'g', 't', ';'
    };
    static final char[] ampAMP = {
        '&', 'a', 'm', 'p', ';'
    };

    /**
     * Construct a new HtmlWriter, as a filter on the specified writer
     *
     * @param os the underlying writer
     */
    public HtmlWriter(Writer os) {
        this.os = os;
    }
    
    /**
     * Write a single character.
     *
     * @param c the character
     * @exception IOException may be thrown by the underlying writer
     */
    public void write(int c) throws IOException {
        switch (c) {
        case '<':
            os.write(ampLT);
            break;
        case '>':
            os.write(ampGT);
            break;
        case '&':
            os.write(ampAMP);
            break;
        default:
            os.write(c);
        }
    }

    /**
     * Write a portion of a character array.
     *
     * @param cbuf the character array
     * @param offset the first position to write
     * @param len the number of characters to write
     *
     * @exception IOException may be thrown by the underlying writer
     */
    public void write(char cbuf[], int offset, int len) throws IOException {
        int lim = offset + len;
        while (offset < lim) write(cbuf[offset++]);
    }

    /**
     * Flush the underlying writer.
     *
     * @exception IOException may be thrown by the underlying writer
     */
    public void flush() throws IOException {
        os.flush();
    }

    /**
     * Close the underlying writer.
     * 
     * @exception IOException may be thrown by the underlying writer
     */
    public void close() throws IOException {
        os.close();
    }
}