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 26package com.sun.xml.internal.bind.v2.runtime.output; 27 28import java.io.IOException; 29 30/** 31 * Text data in XML. 32 * 33 * <p> 34 * This class is used inside the marshaller/unmarshaller to 35 * send/receive text data. 36 * 37 * <p> 38 * On top of {@link CharSequence}, this class has an 39 * ability to write itself to the {@link XmlOutput}. This allows 40 * the implementation to choose the most efficient way possible 41 * when writing to XML (for example, it can skip the escaping 42 * of buffer copying.) 43 * 44 * TODO: visitor pattern support? 45 * 46 * @author Kohsuke Kawaguchi 47 */ 48public abstract class Pcdata implements CharSequence { 49 50 /** 51 * Writes itself to {@link UTF8XmlOutput}. 52 * 53 * <p> 54 * This is the most performance critical path for the marshaller, 55 * so it warrants its own method. 56 */ 57 public abstract void writeTo(UTF8XmlOutput output) throws IOException; 58 59 /** 60 * Writes itself to the character array. 61 * 62 * <p> 63 * This method is used by most other {@link XmlOutput}. 64 * The default implementation involves in one extra char[] copying. 65 * 66 * <p> 67 * The caller must provide a big enough buffer that can hold 68 * enough characters returned by the {@link #length()} method. 69 */ 70 public void writeTo(char[] buf, int start) { 71 toString().getChars(0,length(),buf,start); 72 } 73 74 public abstract String toString(); 75} 76