XMLEncoder.java revision 6051
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 * 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 * 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 * 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 * 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.schenkimport java.nio.charset.IllegalCharsetNameException;
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenkimport java.nio.charset.UnsupportedCharsetException;
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 * 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 * 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 * 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 * <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 * <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 * <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 * Below is an example of an XML archive containing
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * some user interface components from the <em>swing</em> toolkit:
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <?xml version="1.0" encoding="UTF-8"?>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <java version="1.0" class="java.beans.XMLDecoder">
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <object class="javax.swing.JFrame">
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <void property="name">
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <string>frame1</string>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * </void>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <void property="bounds">
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <object class="java.awt.Rectangle">
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <int>0</int>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <int>0</int>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <int>200</int>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <int>200</int>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * </object>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * </void>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <void property="contentPane">
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <void method="add">
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <object class="javax.swing.JButton">
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <void property="label">
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <string>Hello</string>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * </void>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * </object>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * </void>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * </void>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <void property="visible">
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <boolean>true</boolean>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * </void>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * </object>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * </java>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * The XML syntax uses the following conventions:
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Each element represents a method call.
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 * 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 * Elements which contain elements use those elements as arguments,
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * unless they have the tag: "void".
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * The name of the method is denoted by the "method" attribute.
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 * 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 * 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 * Java's String class is treated specially and is
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * written <string>Hello, world</string> where
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * the characters of the string are converted to bytes
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * using the UTF-8 character encoding.
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 * The default method name is "new".
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * A reference to a java class is written in the form
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * <class>javax.swing.JButton</class>.
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 * <int>123</int>. 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 * 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 * 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 * 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 * 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 * 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 * For more information you might also want to check out
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 * @since 1.4
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @author Philip Milne
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenkpublic class XMLEncoder extends Encoder implements AutoCloseable {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk private final boolean declaration;
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 class ValueData {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk public boolean marked = false; // Marked -> refs > 0 unless ref was a target.
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 * @param out the stream to which the XML representation of
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * the objects will be written
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @throws IllegalArgumentException
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * if <code>out</code> is <code>null</code>
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @see XMLDecoder#XMLDecoder(InputStream)
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 * @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 * @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 * @throws IllegalCharsetNameException
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * if <code>charset</code> name is illegal
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 * @throws UnsupportedOperationException
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * if loaded charset does not support encoding
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @see Charset#forName(String)
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @since 1.7
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk public XMLEncoder(OutputStream out, String charset, boolean declaration, int indentation) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk throw new IllegalArgumentException("the output stream cannot be null");
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk throw new IllegalArgumentException("the indentation must be >= 0");
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 * Sets the owner of this encoder to <code>owner</code>.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @param owner The owner of this encoder.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @see #getOwner
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk writeExpression(new Expression(this, "getOwner", new Object[0]));
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Gets the owner of this encoder.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @return The owner of this encoder.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @see #setOwner
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Write an XML representation of the specified object to the output.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @param o The object to be written to the stream.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @see XMLDecoder#readObject
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk writeStatement(new Statement(this, "writeObject", new Object[]{o}));
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk private List<Statement> statementList(Object target) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk List<Statement> list = targetToStatementList.get(target);
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk private void mark(Object o, boolean isArgument) {
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk if (o == null || o == this) {
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 // Bump the reference counts of all arguments
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // Pending: Why does the reference count need to
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk // be incremented here?
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * Records the Statement so that the Encoder will
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * produce the actual output when the stream is flushed.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * This method should only be invoked within the context
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * of initializing a persistence delegate.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @param oldStm The statement that will be written
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * to the stream.
4b8d88eb610aa1e0bb6ec632f792744b3d6b5f22jeff.schenk * @see java.beans.PersistenceDelegate#initialize
this.internal = true;
catch (Exception e) {
getExceptionListener().exceptionThrown(new Exception("XMLEncoder: discarding statement " + oldStm, e));
this.internal = true;
public void flush() {
if (this.declaration) {
preambleWritten = true;
indentation++;
outputStatement(s, this, false);
indentation--;
catch (IOException e) {
clear();
void clear() {
super.clear();
public void close() {
flush();
catch (IOException e) {
if (d == null) {
d = new ValueData();
catch (IOException e) {
if (isArgument) {
switch(code) {
default: return null;
index++;
if (expression) {
indentation++;
indentation--;
return null;