01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36:
37: package com.sun.xml.bind.v2.runtime.output;
38:
39: import java.io.IOException;
40:
41: /**
42: * Text data in XML.
43: *
44: * <p>
45: * This class is used inside the marshaller/unmarshaller to
46: * send/receive text data.
47: *
48: * <p>
49: * On top of {@link CharSequence}, this class has an
50: * ability to write itself to the {@link XmlOutput}. This allows
51: * the implementation to choose the most efficient way possible
52: * when writing to XML (for example, it can skip the escaping
53: * of buffer copying.)
54: *
55: * TODO: visitor pattern support?
56: *
57: * @author Kohsuke Kawaguchi
58: */
59: public abstract class Pcdata implements CharSequence {
60:
61: /**
62: * Writes itself to {@link UTF8XmlOutput}.
63: *
64: * <p>
65: * This is the most performance critical path for the marshaller,
66: * so it warrants its own method.
67: */
68: public abstract void writeTo(UTF8XmlOutput output)
69: throws IOException;
70:
71: /**
72: * Writes itself to the character array.
73: *
74: * <p>
75: * This method is used by most other {@link XmlOutput}.
76: * The default implementation involves in one extra char[] copying.
77: *
78: * <p>
79: * The caller must provide a big enough buffer that can hold
80: * enough characters returned by the {@link #length()} method.
81: */
82: public void writeTo(char[] buf, int start) {
83: toString().getChars(0, length(), buf, start);
84: }
85:
86: public abstract String toString();
87: }
|