aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.bind.v2.runtime.output;
aoqi@0: 
aoqi@0: import java.io.IOException;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Text data in XML.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * This class is used inside the marshaller/unmarshaller to
aoqi@0:  * send/receive text data.
aoqi@0:  *
aoqi@0:  * <p>
aoqi@0:  * On top of {@link CharSequence}, this class has an
aoqi@0:  * ability to write itself to the {@link XmlOutput}. This allows
aoqi@0:  * the implementation to choose the most efficient way possible
aoqi@0:  * when writing to XML (for example, it can skip the escaping
aoqi@0:  * of buffer copying.)
aoqi@0:  *
aoqi@0:  * TODO: visitor pattern support?
aoqi@0:  *
aoqi@0:  * @author Kohsuke Kawaguchi
aoqi@0:  */
aoqi@0: public abstract class Pcdata implements CharSequence {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Writes itself to {@link UTF8XmlOutput}.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * This is the most performance critical path for the marshaller,
aoqi@0:      * so it warrants its own method.
aoqi@0:      */
aoqi@0:     public abstract void writeTo(UTF8XmlOutput output) throws IOException;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Writes itself to the character array.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * This method is used by most other {@link XmlOutput}.
aoqi@0:      * The default implementation involves in one extra char[] copying.
aoqi@0:      *
aoqi@0:      * <p>
aoqi@0:      * The caller must provide a big enough buffer that can hold
aoqi@0:      * enough characters returned by the {@link #length()} method.
aoqi@0:      */
aoqi@0:     public void writeTo(char[] buf, int start) {
aoqi@0:         toString().getChars(0,length(),buf,start);
aoqi@0:     }
aoqi@0: 
aoqi@0:     public abstract String toString();
aoqi@0: }