1 /*
   2  * Copyright (c) 1997, 2012, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.xml.internal.bind.marshaller;
  27 
  28 import java.io.IOException;
  29 import java.io.Writer;
  30 
  31 /**
  32  * Performs character escaping and write the result
  33  * to the output.
  34  *
  35  * @since 1.0.1
  36  * @author
  37  *     Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)
  38  */
  39 public interface CharacterEscapeHandler {
  40 
  41     /**
  42      * @param ch The array of characters.
  43      * @param start The starting position.
  44      * @param length The number of characters to use.
  45      * @param isAttVal true if this is an attribute value literal.
  46      */
  47     void escape( char[] ch, int start, int length, boolean isAttVal, Writer out ) throws IOException;
  48 
  49 }