XMLEncoder.java revision 6051
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk/*
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Copyright (c) 2000, 2010, Oracle and/or its affiliates. All rights reserved.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * This code is free software; you can redistribute it and/or modify it
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * under the terms of the GNU General Public License version 2 only, as
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * published by the Free Software Foundation. Oracle designates this
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * particular file as subject to the "Classpath" exception as provided
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * by Oracle in the LICENSE file that accompanied this code.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * This code is distributed in the hope that it will be useful, but WITHOUT
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * version 2 for more details (a copy is included in the LICENSE file that
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * accompanied this code).
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * You should have received a copy of the GNU General Public License version
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * 2 along with this work; if not, write to the Free Software Foundation,
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * or visit www.oracle.com if you need additional information or have any
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * questions.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk */
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenkpackage java.beans;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenkimport java.io.*;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenkimport java.util.*;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenkimport java.lang.reflect.*;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenkimport java.nio.charset.Charset;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenkimport java.nio.charset.CharsetEncoder;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenkimport java.nio.charset.IllegalCharsetNameException;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenkimport java.nio.charset.UnsupportedCharsetException;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk/**
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * The <code>XMLEncoder</code> class is a complementary alternative to
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * the <code>ObjectOutputStream</code> and can used to generate
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * a textual representation of a <em>JavaBean</em> in the same
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * way that the <code>ObjectOutputStream</code> can
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * be used to create binary representation of <code>Serializable</code>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * objects. For example, the following fragment can be used to create
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * a textual representation the supplied <em>JavaBean</em>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * and all its properties:
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <pre>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * XMLEncoder e = new XMLEncoder(
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * new BufferedOutputStream(
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * new FileOutputStream("Test.xml")));
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * e.writeObject(new JButton("Hello, world"));
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * e.close();
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * </pre>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Despite the similarity of their APIs, the <code>XMLEncoder</code>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * class is exclusively designed for the purpose of archiving graphs
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * of <em>JavaBean</em>s as textual representations of their public
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * properties. Like Java source files, documents written this way
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * have a natural immunity to changes in the implementations of the classes
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * involved. The <code>ObjectOutputStream</code> continues to be recommended
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * for interprocess communication and general purpose serialization.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <p>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * The <code>XMLEncoder</code> class provides a default denotation for
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <em>JavaBean</em>s in which they are represented as XML documents
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * complying with version 1.0 of the XML specification and the
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * UTF-8 character encoding of the Unicode/ISO 10646 character set.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * The XML documents produced by the <code>XMLEncoder</code> class are:
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <ul>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <li>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <em>Portable and version resilient</em>: they have no dependencies
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * on the private implementation of any class and so, like Java source
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * files, they may be exchanged between environments which may have
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * different versions of some of the classes and between VMs from
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * different vendors.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <li>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <em>Structurally compact</em>: The <code>XMLEncoder</code> class
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * uses a <em>redundancy elimination</em> algorithm internally so that the
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * default values of a Bean's properties are not written to the stream.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <li>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <em>Fault tolerant</em>: Non-structural errors in the file,
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * caused either by damage to the file or by API changes
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * made to classes in an archive remain localized
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * so that a reader can report the error and continue to load the parts
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * of the document which were not affected by the error.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * </ul>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <p>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Below is an example of an XML archive containing
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * some user interface components from the <em>swing</em> toolkit:
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <pre>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;?xml version="1.0" encoding="UTF-8"?&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;java version="1.0" class="java.beans.XMLDecoder"&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;object class="javax.swing.JFrame"&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;void property="name"&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;string&gt;frame1&lt;/string&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;/void&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;void property="bounds"&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;object class="java.awt.Rectangle"&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;int&gt;0&lt;/int&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;int&gt;0&lt;/int&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;int&gt;200&lt;/int&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;int&gt;200&lt;/int&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;/object&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;/void&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;void property="contentPane"&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;void method="add"&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;object class="javax.swing.JButton"&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;void property="label"&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;string&gt;Hello&lt;/string&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;/void&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;/object&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;/void&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;/void&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;void property="visible"&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;boolean&gt;true&lt;/boolean&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;/void&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;/object&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;/java&gt;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * </pre>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * The XML syntax uses the following conventions:
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <ul>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <li>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Each element represents a method call.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <li>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * The "object" tag denotes an <em>expression</em> whose value is
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * to be used as the argument to the enclosing element.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <li>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * The "void" tag denotes a <em>statement</em> which will
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * be executed, but whose result will not be used as an
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * argument to the enclosing method.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <li>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Elements which contain elements use those elements as arguments,
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * unless they have the tag: "void".
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <li>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * The name of the method is denoted by the "method" attribute.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <li>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * XML's standard "id" and "idref" attributes are used to make
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * references to previous expressions - so as to deal with
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * circularities in the object graph.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <li>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * The "class" attribute is used to specify the target of a static
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * method or constructor explicitly; its value being the fully
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * qualified name of the class.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <li>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Elements with the "void" tag are executed using
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * the outer context as the target if no target is defined
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * by a "class" attribute.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <li>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Java's String class is treated specially and is
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * written &lt;string&gt;Hello, world&lt;/string&gt; where
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * the characters of the string are converted to bytes
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * using the UTF-8 character encoding.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * </ul>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <p>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Although all object graphs may be written using just these three
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * tags, the following definitions are included so that common
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * data structures can be expressed more concisely:
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <p>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <ul>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <li>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * The default method name is "new".
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <li>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * A reference to a java class is written in the form
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;class&gt;javax.swing.JButton&lt;/class&gt;.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <li>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Instances of the wrapper classes for Java's primitive types are written
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * using the name of the primitive type as the tag. For example, an
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * instance of the <code>Integer</code> class could be written:
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * &lt;int&gt;123&lt;/int&gt;. Note that the <code>XMLEncoder</code> class
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * uses Java's reflection package in which the conversion between
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Java's primitive types and their associated "wrapper classes"
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * is handled internally. The API for the <code>XMLEncoder</code> class
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * itself deals only with <code>Object</code>s.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <li>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * In an element representing a nullary method whose name
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * starts with "get", the "method" attribute is replaced
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * with a "property" attribute whose value is given by removing
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * the "get" prefix and decapitalizing the result.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <li>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * In an element representing a monadic method whose name
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * starts with "set", the "method" attribute is replaced
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * with a "property" attribute whose value is given by removing
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * the "set" prefix and decapitalizing the result.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <li>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * In an element representing a method named "get" taking one
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * integer argument, the "method" attribute is replaced
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * with an "index" attribute whose value the value of the
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * first argument.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <li>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * In an element representing a method named "set" taking two arguments,
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * the first of which is an integer, the "method" attribute is replaced
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * with an "index" attribute whose value the value of the
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * first argument.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <li>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * A reference to an array is written using the "array"
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * tag. The "class" and "length" attributes specify the
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * sub-type of the array and its length respectively.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * </ul>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *<p>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * For more information you might also want to check out
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <a
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk href="http://java.sun.com/products/jfc/tsc/articles/persistence4">Using XMLEncoder</a>,
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * an article in <em>The Swing Connection.</em>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @see XMLDecoder
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @see java.io.ObjectOutputStream
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @since 1.4
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @author Philip Milne
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk */
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenkpublic class XMLEncoder extends Encoder implements AutoCloseable {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk private final CharsetEncoder encoder;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk private final String charset;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk private final boolean declaration;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk private OutputStreamWriter out;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk private Object owner;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk private int indentation = 0;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk private boolean internal = false;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk private Map<Object, ValueData> valueToExpression;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk private Map<Object, List<Statement>> targetToStatementList;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk private boolean preambleWritten = false;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk private NameGenerator nameGenerator;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk private class ValueData {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk public int refs = 0;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk public boolean marked = false; // Marked -> refs > 0 unless ref was a target.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk public String name = null;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk public Expression exp = null;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk }
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk /**
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Creates a new XML encoder to write out <em>JavaBeans</em>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * to the stream <code>out</code> using an XML encoding.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @param out the stream to which the XML representation of
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * the objects will be written
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @throws IllegalArgumentException
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * if <code>out</code> is <code>null</code>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @see XMLDecoder#XMLDecoder(InputStream)
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk */
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk public XMLEncoder(OutputStream out) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk this(out, "UTF-8", true, 0);
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk }
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk /**
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Creates a new XML encoder to write out <em>JavaBeans</em>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * to the stream <code>out</code> using the given <code>charset</code>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * starting from the given <code>indentation</code>.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @param out the stream to which the XML representation of
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * the objects will be written
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @param charset the name of the requested charset;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * may be either a canonical name or an alias
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @param declaration whether the XML declaration should be generated;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * set this to <code>false</code>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * when embedding the contents in another XML document
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @param indentation the number of space characters to indent the entire XML document by
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @throws IllegalArgumentException
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * if <code>out</code> or <code>charset</code> is <code>null</code>,
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * or if <code>indentation</code> is less than 0
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @throws IllegalCharsetNameException
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * if <code>charset</code> name is illegal
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @throws UnsupportedCharsetException
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * if no support for the named charset is available
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * in this instance of the Java virtual machine
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @throws UnsupportedOperationException
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * if loaded charset does not support encoding
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @see Charset#forName(String)
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @since 1.7
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk */
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk public XMLEncoder(OutputStream out, String charset, boolean declaration, int indentation) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk if (out == null) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk throw new IllegalArgumentException("the output stream cannot be null");
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk }
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk if (indentation < 0) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk throw new IllegalArgumentException("the indentation must be >= 0");
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk }
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk Charset cs = Charset.forName(charset);
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk this.encoder = cs.newEncoder();
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk this.charset = charset;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk this.declaration = declaration;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk this.indentation = indentation;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk this.out = new OutputStreamWriter(out, cs.newEncoder());
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk valueToExpression = new IdentityHashMap<Object, ValueData>();
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk targetToStatementList = new IdentityHashMap<Object, List<Statement>>();
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk nameGenerator = new NameGenerator();
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk }
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk /**
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Sets the owner of this encoder to <code>owner</code>.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @param owner The owner of this encoder.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @see #getOwner
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk */
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk public void setOwner(Object owner) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk this.owner = owner;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk writeExpression(new Expression(this, "getOwner", new Object[0]));
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk }
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk /**
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Gets the owner of this encoder.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @return The owner of this encoder.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @see #setOwner
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk */
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk public Object getOwner() {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk return owner;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk }
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk /**
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Write an XML representation of the specified object to the output.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @param o The object to be written to the stream.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @see XMLDecoder#readObject
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk */
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk public void writeObject(Object o) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk if (internal) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk super.writeObject(o);
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk }
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk else {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk writeStatement(new Statement(this, "writeObject", new Object[]{o}));
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk }
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk }
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk private List<Statement> statementList(Object target) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk List<Statement> list = targetToStatementList.get(target);
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk if (list == null) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk list = new ArrayList<Statement>();
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk targetToStatementList.put(target, list);
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk }
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk return list;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk }
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk private void mark(Object o, boolean isArgument) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk if (o == null || o == this) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk return;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk }
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk ValueData d = getValueData(o);
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk Expression exp = d.exp;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // Do not mark liternal strings. Other strings, which might,
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // for example, come from resource bundles should still be marked.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk if (o.getClass() == String.class && exp == null) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk return;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk }
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // Bump the reference counts of all arguments
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk if (isArgument) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk d.refs++;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk }
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk if (d.marked) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk return;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk }
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk d.marked = true;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk Object target = exp.getTarget();
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk mark(exp);
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk if (!(target instanceof Class)) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk statementList(target).add(exp);
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // Pending: Why does the reference count need to
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // be incremented here?
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk d.refs++;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk }
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk }
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk private void mark(Statement stm) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk Object[] args = stm.getArguments();
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk for (int i = 0; i < args.length; i++) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk Object arg = args[i];
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk mark(arg, true);
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk }
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk mark(stm.getTarget(), false);
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk }
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk /**
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Records the Statement so that the Encoder will
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * produce the actual output when the stream is flushed.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <P>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * This method should only be invoked within the context
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * of initializing a persistence delegate.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk *
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @param oldStm The statement that will be written
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * to the stream.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @see java.beans.PersistenceDelegate#initialize
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk */
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk public void writeStatement(Statement oldStm) {
// System.out.println("XMLEncoder::writeStatement: " + oldStm);
boolean internal = this.internal;
this.internal = true;
try {
super.writeStatement(oldStm);
/*
Note we must do the mark first as we may
require the results of previous values in
this context for this statement.
Test case is:
os.setOwner(this);
os.writeObject(this);
*/
mark(oldStm);
Object target = oldStm.getTarget();
if (target instanceof Field) {
String method = oldStm.getMethodName();
Object[] args = oldStm.getArguments();
if ((method == null) || (args == null)) {
}
else if (method.equals("get") && (args.length == 1)) {
target = args[0];
}
else if (method.equals("set") && (args.length == 2)) {
target = args[0];
}
}
statementList(target).add(oldStm);
}
catch (Exception e) {
getExceptionListener().exceptionThrown(new Exception("XMLEncoder: discarding statement " + oldStm, e));
}
this.internal = internal;
}
/**
* Records the Expression so that the Encoder will
* produce the actual output when the stream is flushed.
* <P>
* This method should only be invoked within the context of
* initializing a persistence delegate or setting up an encoder to
* read from a resource bundle.
* <P>
* For more information about using resource bundles with the
* XMLEncoder, see
* http://java.sun.com/products/jfc/tsc/articles/persistence4/#i18n
*
* @param oldExp The expression that will be written
* to the stream.
* @see java.beans.PersistenceDelegate#initialize
*/
public void writeExpression(Expression oldExp) {
boolean internal = this.internal;
this.internal = true;
Object oldValue = getValue(oldExp);
if (get(oldValue) == null || (oldValue instanceof String && !internal)) {
getValueData(oldValue).exp = oldExp;
super.writeExpression(oldExp);
}
this.internal = internal;
}
/**
* This method writes out the preamble associated with the
* XML encoding if it has not been written already and
* then writes out all of the values that been
* written to the stream since the last time <code>flush</code>
* was called. After flushing, all internal references to the
* values that were written to this stream are cleared.
*/
public void flush() {
if (!preambleWritten) { // Don't do this in constructor - it throws ... pending.
if (this.declaration) {
writeln("<?xml version=" + quote("1.0") +
" encoding=" + quote(this.charset) + "?>");
}
writeln("<java version=" + quote(System.getProperty("java.version")) +
" class=" + quote(XMLDecoder.class.getName()) + ">");
preambleWritten = true;
}
indentation++;
List<Statement> statements = statementList(this);
while (!statements.isEmpty()) {
Statement s = statements.remove(0);
if ("writeObject".equals(s.getMethodName())) {
outputValue(s.getArguments()[0], this, true);
}
else {
outputStatement(s, this, false);
}
}
indentation--;
try {
out.flush();
}
catch (IOException e) {
getExceptionListener().exceptionThrown(e);
}
clear();
}
void clear() {
super.clear();
nameGenerator.clear();
valueToExpression.clear();
targetToStatementList.clear();
}
/**
* This method calls <code>flush</code>, writes the closing
* postamble and then closes the output stream associated
* with this stream.
*/
public void close() {
flush();
writeln("</java>");
try {
out.close();
}
catch (IOException e) {
getExceptionListener().exceptionThrown(e);
}
}
private String quote(String s) {
return "\"" + s + "\"";
}
private ValueData getValueData(Object o) {
ValueData d = valueToExpression.get(o);
if (d == null) {
d = new ValueData();
valueToExpression.put(o, d);
}
return d;
}
/**
* Returns <code>true</code> if the argument,
* a Unicode code point, is valid in XML documents.
* Unicode characters fit into the low sixteen bits of a Unicode code point,
* and pairs of Unicode <em>surrogate characters</em> can be combined
* to encode Unicode code point in documents containing only Unicode.
* (The <code>char</code> datatype in the Java Programming Language
* represents Unicode characters, including unpaired surrogates.)
* <par>
* [2] Char ::= #x0009 | #x000A | #x000D
* | [#x0020-#xD7FF]
* | [#xE000-#xFFFD]
* | [#x10000-#x10ffff]
* </par>
*
* @param code the 32-bit Unicode code point being tested
* @return <code>true</code> if the Unicode code point is valid,
* <code>false</code> otherwise
*/
private static boolean isValidCharCode(int code) {
return (0x0020 <= code && code <= 0xD7FF)
|| (0x000A == code)
|| (0x0009 == code)
|| (0x000D == code)
|| (0xE000 <= code && code <= 0xFFFD)
|| (0x10000 <= code && code <= 0x10ffff);
}
private void writeln(String exp) {
try {
StringBuilder sb = new StringBuilder();
for(int i = 0; i < indentation; i++) {
sb.append(' ');
}
sb.append(exp);
sb.append('\n');
this.out.write(sb.toString());
}
catch (IOException e) {
getExceptionListener().exceptionThrown(e);
}
}
private void outputValue(Object value, Object outer, boolean isArgument) {
if (value == null) {
writeln("<null/>");
return;
}
if (value instanceof Class) {
writeln("<class>" + ((Class)value).getName() + "</class>");
return;
}
ValueData d = getValueData(value);
if (d.exp != null) {
Object target = d.exp.getTarget();
String methodName = d.exp.getMethodName();
if (target == null || methodName == null) {
throw new NullPointerException((target == null ? "target" :
"methodName") + " should not be null");
}
if (target instanceof Field && methodName.equals("get")) {
Field f = (Field)target;
writeln("<object class=" + quote(f.getDeclaringClass().getName()) +
" field=" + quote(f.getName()) + "/>");
return;
}
Class primitiveType = primitiveTypeFor(value.getClass());
if (primitiveType != null && target == value.getClass() &&
methodName.equals("new")) {
String primitiveTypeName = primitiveType.getName();
// Make sure that character types are quoted correctly.
if (primitiveType == Character.TYPE) {
char code = ((Character) value).charValue();
if (!isValidCharCode(code)) {
writeln(createString(code));
return;
}
value = quoteCharCode(code);
if (value == null) {
value = Character.valueOf(code);
}
}
writeln("<" + primitiveTypeName + ">" + value + "</" +
primitiveTypeName + ">");
return;
}
} else if (value instanceof String) {
writeln(createString((String) value));
return;
}
if (d.name != null) {
if (isArgument) {
writeln("<object idref=" + quote(d.name) + "/>");
}
else {
outputXML("void", " idref=" + quote(d.name), value);
}
}
else if (d.exp != null) {
outputStatement(d.exp, outer, isArgument);
}
}
private static String quoteCharCode(int code) {
switch(code) {
case '&': return "&amp;";
case '<': return "&lt;";
case '>': return "&gt;";
case '"': return "&quot;";
case '\'': return "&apos;";
case '\r': return "&#13;";
default: return null;
}
}
private static String createString(int code) {
return "<char code=\"#" + Integer.toString(code, 16) + "\"/>";
}
private String createString(String string) {
StringBuilder sb = new StringBuilder();
sb.append("<string>");
int index = 0;
while (index < string.length()) {
int point = string.codePointAt(index);
int count = Character.charCount(point);
if (isValidCharCode(point) && this.encoder.canEncode(string.substring(index, index + count))) {
String value = quoteCharCode(point);
if (value != null) {
sb.append(value);
} else {
sb.appendCodePoint(point);
}
index += count;
} else {
sb.append(createString(string.charAt(index)));
index++;
}
}
sb.append("</string>");
return sb.toString();
}
private void outputStatement(Statement exp, Object outer, boolean isArgument) {
Object target = exp.getTarget();
String methodName = exp.getMethodName();
if (target == null || methodName == null) {
throw new NullPointerException((target == null ? "target" :
"methodName") + " should not be null");
}
Object[] args = exp.getArguments();
boolean expression = exp.getClass() == Expression.class;
Object value = (expression) ? getValue((Expression)exp) : null;
String tag = (expression && isArgument) ? "object" : "void";
String attributes = "";
ValueData d = getValueData(value);
// Special cases for targets.
if (target == outer) {
}
else if (target == Array.class && methodName.equals("newInstance")) {
tag = "array";
attributes = attributes + " class=" + quote(((Class)args[0]).getName());
attributes = attributes + " length=" + quote(args[1].toString());
args = new Object[]{};
}
else if (target.getClass() == Class.class) {
attributes = attributes + " class=" + quote(((Class)target).getName());
}
else {
d.refs = 2;
if (d.name == null) {
getValueData(target).refs++;
List<Statement> statements = statementList(target);
if (!statements.contains(exp)) {
statements.add(exp);
}
outputValue(target, outer, false);
}
if (expression) {
outputValue(value, outer, isArgument);
}
return;
}
if (expression && (d.refs > 1)) {
String instanceName = nameGenerator.instanceName(value);
d.name = instanceName;
attributes = attributes + " id=" + quote(instanceName);
}
// Special cases for methods.
if ((!expression && methodName.equals("set") && args.length == 2 &&
args[0] instanceof Integer) ||
(expression && methodName.equals("get") && args.length == 1 &&
args[0] instanceof Integer)) {
attributes = attributes + " index=" + quote(args[0].toString());
args = (args.length == 1) ? new Object[]{} : new Object[]{args[1]};
}
else if ((!expression && methodName.startsWith("set") && args.length == 1) ||
(expression && methodName.startsWith("get") && args.length == 0)) {
if (3 < methodName.length()) {
attributes = attributes + " property=" +
quote(Introspector.decapitalize(methodName.substring(3)));
}
}
else if (!methodName.equals("new") && !methodName.equals("newInstance")) {
attributes = attributes + " method=" + quote(methodName);
}
outputXML(tag, attributes, value, args);
}
private void outputXML(String tag, String attributes, Object value, Object... args) {
List<Statement> statements = statementList(value);
// Use XML's short form when there is no body.
if (args.length == 0 && statements.size() == 0) {
writeln("<" + tag + attributes + "/>");
return;
}
writeln("<" + tag + attributes + ">");
indentation++;
for(int i = 0; i < args.length; i++) {
outputValue(args[i], null, true);
}
while (!statements.isEmpty()) {
Statement s = statements.remove(0);
outputStatement(s, value, false);
}
indentation--;
writeln("</" + tag + ">");
}
@SuppressWarnings("rawtypes")
static Class primitiveTypeFor(Class wrapper) {
if (wrapper == Boolean.class) return Boolean.TYPE;
if (wrapper == Byte.class) return Byte.TYPE;
if (wrapper == Character.class) return Character.TYPE;
if (wrapper == Short.class) return Short.TYPE;
if (wrapper == Integer.class) return Integer.TYPE;
if (wrapper == Long.class) return Long.TYPE;
if (wrapper == Float.class) return Float.TYPE;
if (wrapper == Double.class) return Double.TYPE;
if (wrapper == Void.class) return Void.TYPE;
return null;
}
}