jdk8-mips64-public/jaxws: src/share/jaxws_classes/com/sun/xml/internal/bind/marshaller/DataWriter.java@e530533619ec (annotated)

src/share/jaxws_classes/com/sun/xml/internal/bind/marshaller/DataWriter.java@e530533619ec (annotated)

src/share/jaxws_classes/com/sun/xml/internal/bind/marshaller/DataWriter.java

Thu, 12 Oct 2017 19:44:07 +0800

author: aoqi
date: Thu, 12 Oct 2017 19:44:07 +0800
changeset 760: e530533619ec
parent 0: 373ffda63c9a
permissions: -rw-r--r--

merge

 /*
  * Copyright (c) 1997, 2011, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License version 2 only, as
  * published by the Free Software Foundation.  Oracle designates this
  * particular file as subject to the "Classpath" exception as provided
  * by Oracle in the LICENSE file that accompanied this code.
  *
  * This code is distributed in the hope that it will be useful, but WITHOUT
  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * version 2 for more details (a copy is included in the LICENSE file that
  * accompanied this code).
  *
  * You should have received a copy of the GNU General Public License version
  * 2 along with this work; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  *
  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  * or visit www.oracle.com if you need additional information or have any
  * questions.
  */
 //@@3RD PARTY CODE@@
 // DataWriter.java - XML writer for data-oriented files.
 package com.sun.xml.internal.bind.marshaller;
 import java.io.IOException;
 import java.io.Writer;
 import java.util.Stack;
 import org.xml.sax.Attributes;
 import org.xml.sax.SAXException;
 /**
  * Write data- or field-oriented XML.
  *
  * <p>This filter pretty-prints field-oriented XML without mixed content.
  * all added indentation and newlines will be passed on down
  * the filter chain (if any).</p>
  *
  * <p>In general, all whitespace in an XML document is potentially
  * significant, so a general-purpose XML writing tool like the
  * {@link XMLWriter} class cannot
  * add newlines or indentation.</p>
  *
  * <p>There is, however, a large class of XML documents where information
  * is strictly fielded: each element contains either character data
  * or other elements, but not both.  For this special case, it is possible
  * for a writing tool to provide automatic indentation and newlines
  * without requiring extra work from the user.  Note that this class
  * will likely not yield appropriate results for document-oriented
  * XML like XHTML pages, which mix character data and elements together.</p>
  *
  * <p>This writer will automatically place each start tag on a new line,
  * optionally indented if an indent step is provided (by default, there
  * is no indentation).  If an element contains other elements, the end
  * tag will also appear on a new line with leading indentation.  Consider,
  * for example, the following code:</p>
  *
  * <pre>
  * DataWriter w = new DataWriter();
  *
  * w.setIndentStep(2);
  * w.startDocument();
  * w.startElement("Person");
  * w.dataElement("name", "Jane Smith");
  * w.dataElement("date-of-birth", "1965-05-23");
  * w.dataElement("citizenship", "US");
  * w.endElement("Person");
  * w.endDocument();
  * </pre>
  *
  * <p>This code will produce the following document:</p>
  *
  * <pre>
  * &lt;?xml version="1.0" standalone="yes"?>
  *
  * &lt;Person>
  *   &lt;name>Jane Smith&lt;/name>
  *   &lt;date-of-birth>1965-05-23&lt;/date-of-birth>
  *   &lt;citizenship>US&lt;/citizenship>
  * &lt;/Person>
  * </pre>
  *
  * <p>This class inherits from {@link XMLWriter},
  * and provides all of the same support for Namespaces.</p>
  *
  * @since 1.0
  * @author David Megginson, david@megginson.com
  * @version 0.2
  * @see XMLWriter
  */
 public class DataWriter extends XMLWriter
 {
     ////////////////////////////////////////////////////////////////////
     // Constructors.
     ////////////////////////////////////////////////////////////////////
     /**
      * Create a new data writer for the specified output.
      *
      * @param writer The character stream where the XML document
      *        will be written.
      * @param encoding
      *      If non-null string is specified, it is written as a part
      *      of the XML declaration.
      */
     public DataWriter ( Writer writer, String encoding, CharacterEscapeHandler _escapeHandler )
     {
         super(writer,encoding,_escapeHandler);
     }
     public DataWriter (Writer writer, String encoding ) {
         this( writer, encoding, DumbEscapeHandler.theInstance );
     }
     ////////////////////////////////////////////////////////////////////
     // Accessors and setters.
     ////////////////////////////////////////////////////////////////////
     /**
      * Return the current indent step.
      *
      * <p>Return the current indent step: each start tag will be
      * indented by this number of spaces times the number of
      * ancestors that the element has.</p>
      *
      * @return The number of spaces in each indentation step,
      *         or 0 or less for no indentation.
      * @see #setIndentStep(int)
      *
      * @deprecated
      *      Only return the length of the indent string.
      */
     public int getIndentStep ()
     {
         return indentStep.length();
     }
     /**
      * Set the current indent step.
      *
      * @param indentStep The new indent step (0 or less for no
      *        indentation).
      * @see #getIndentStep()
      *
      * @deprecated
      *      Should use the version that takes string.
      */
     public void setIndentStep (int indentStep)
     {
         StringBuilder buf = new StringBuilder();
         for( ; indentStep>0; indentStep-- )
             buf.append(' ');
         setIndentStep(buf.toString());
     }
     public void setIndentStep(String s) {
         this.indentStep = s;
     }
     ////////////////////////////////////////////////////////////////////
     // Override methods from XMLWriter.
     ////////////////////////////////////////////////////////////////////
     /**
      * Reset the writer so that it can be reused.
      *
      * <p>This method is especially useful if the writer failed
      * with an exception the last time through.</p>
      *
      * @see XMLWriter#reset()
      */
     public void reset ()
     {
         depth = 0;
         state = SEEN_NOTHING;
         stateStack = new Stack<Object>();
         super.reset();
     }
     protected void writeXmlDecl(String decl) throws IOException {
         super.writeXmlDecl(decl);
         write('\n');
     }
     /**
      * Write a start tag.
      *
      * <p>Each tag will begin on a new line, and will be
      * indented by the current indent step times the number
      * of ancestors that the element has.</p>
      *
      * <p>The newline and indentation will be passed on down
      * the filter chain through regular characters events.</p>
      *
      * @param uri The element's Namespace URI.
      * @param localName The element's local name.
      * @param qName The element's qualified (prefixed) name.
      * @param atts The element's attribute list.
      * @exception org.xml.sax.SAXException If there is an error
      *            writing the start tag, or if a filter further
      *            down the chain raises an exception.
      * @see XMLWriter#startElement(String, String, String, Attributes)
      */
     public void startElement (String uri, String localName,
                               String qName, Attributes atts)
         throws SAXException
     {
         stateStack.push(SEEN_ELEMENT);
         state = SEEN_NOTHING;
         if (depth > 0) {
             super.characters("\n");
         }
         doIndent();
         super.startElement(uri, localName, qName, atts);
         depth++;
     }
     /**
      * Write an end tag.
      *
      * <p>If the element has contained other elements, the tag
      * will appear indented on a new line; otherwise, it will
      * appear immediately following whatever came before.</p>
      *
      * <p>The newline and indentation will be passed on down
      * the filter chain through regular characters events.</p>
      *
      * @param uri The element's Namespace URI.
      * @param localName The element's local name.
      * @param qName The element's qualified (prefixed) name.
      * @exception org.xml.sax.SAXException If there is an error
      *            writing the end tag, or if a filter further
      *            down the chain raises an exception.
      * @see XMLWriter#endElement(String, String, String)
      */
     public void endElement (String uri, String localName, String qName)
         throws SAXException
     {
         depth--;
         if (state == SEEN_ELEMENT) {
             super.characters("\n");
             doIndent();
         }
         super.endElement(uri, localName, qName);
         state = stateStack.pop();
     }
     public void endDocument() throws SAXException {
         try {
             write('\n');
         } catch( IOException e ) {
             throw new SAXException(e);
         }
         super.endDocument();
     }
 //    /**
 //     * Write a empty element tag.
 //     *
 //     * <p>Each tag will appear on a new line, and will be
 //     * indented by the current indent step times the number
 //     * of ancestors that the element has.</p>
 //     *
 //     * <p>The newline and indentation will be passed on down
 //     * the filter chain through regular characters events.</p>
 //     *
 //     * @param uri The element's Namespace URI.
 //     * @param localName The element's local name.
 //     * @param qName The element's qualified (prefixed) name.
 //     * @param atts The element's attribute list.
 //     * @exception org.xml.sax.SAXException If there is an error
 //     *            writing the empty tag, or if a filter further
 //     *            down the chain raises an exception.
 //     * @see XMLWriter#emptyElement(String, String, String, Attributes)
 //     */
 //    public void emptyElement (String uri, String localName,
 //                              String qName, Attributes atts)
 //        throws SAXException
 //    {
 //        state = SEEN_ELEMENT;
 //        if (depth > 0) {
 //            super.characters("\n");
 //        }
 //        doIndent();
 //        super.emptyElement(uri, localName, qName, atts);
 //    }
     /**
      * Write a sequence of characters.
      *
      * @param ch The characters to write.
      * @param start The starting position in the array.
      * @param length The number of characters to use.
      * @exception org.xml.sax.SAXException If there is an error
      *            writing the characters, or if a filter further
      *            down the chain raises an exception.
      * @see XMLWriter#characters(char[], int, int)
      */
     public void characters (char ch[], int start, int length)
         throws SAXException
     {
         state = SEEN_DATA;
         super.characters(ch, start, length);
     }
     ////////////////////////////////////////////////////////////////////
     // Internal methods.
     ////////////////////////////////////////////////////////////////////
     /**
      * Print indentation for the current level.
      *
      * @exception org.xml.sax.SAXException If there is an error
      *            writing the indentation characters, or if a filter
      *            further down the chain raises an exception.
      */
     private void doIndent ()
         throws SAXException
     {
         if (depth > 0) {
             char[] ch = indentStep.toCharArray();
             for( int i=0; i<depth; i++ )
                 characters(ch, 0, ch.length);
         }
     }
     ////////////////////////////////////////////////////////////////////
     // Constants.
     ////////////////////////////////////////////////////////////////////
     private final static Object SEEN_NOTHING = new Object();
     private final static Object SEEN_ELEMENT = new Object();
     private final static Object SEEN_DATA = new Object();
     ////////////////////////////////////////////////////////////////////
     // Internal state.
     ////////////////////////////////////////////////////////////////////
     private Object state = SEEN_NOTHING;
     private Stack<Object> stateStack = new Stack<Object>();
     private String indentStep = "";
     private int depth = 0;
 }
 // end of DataWriter.java

Mercurial > jdk8-mips64-public > jaxws / annotate

src/share/jaxws_classes/com/sun/xml/internal/bind/marshaller/DataWriter.java@e530533619ec (annotated)

src/share/jaxws_classes/com/sun/xml/internal/bind/marshaller/DataWriter.java