Sun, 18 Jun 2017 23:18:45 +0100
8172297: In java 8, the marshalling with JAX-WS does not escape carriage return
Reviewed-by: lancea
aoqi@0 | 1 | /* |
aoqi@0 | 2 | * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. |
aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
aoqi@0 | 4 | * |
aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
aoqi@0 | 10 | * |
aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
aoqi@0 | 15 | * accompanied this code). |
aoqi@0 | 16 | * |
aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
aoqi@0 | 20 | * |
aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
aoqi@0 | 23 | * questions. |
aoqi@0 | 24 | */ |
aoqi@0 | 25 | |
aoqi@0 | 26 | package com.sun.xml.internal.txw2.output; |
aoqi@0 | 27 | |
aoqi@0 | 28 | import javax.xml.stream.XMLStreamException; |
aoqi@0 | 29 | import javax.xml.stream.XMLStreamWriter; |
aoqi@0 | 30 | import java.util.Stack; |
aoqi@0 | 31 | |
aoqi@0 | 32 | /** |
aoqi@0 | 33 | * @author Kohsuke Kawaguchi |
aoqi@0 | 34 | */ |
aoqi@0 | 35 | public class IndentingXMLStreamWriter extends DelegatingXMLStreamWriter { |
aoqi@0 | 36 | private final static Object SEEN_NOTHING = new Object(); |
aoqi@0 | 37 | private final static Object SEEN_ELEMENT = new Object(); |
aoqi@0 | 38 | private final static Object SEEN_DATA = new Object(); |
aoqi@0 | 39 | |
aoqi@0 | 40 | private Object state = SEEN_NOTHING; |
aoqi@0 | 41 | private Stack<Object> stateStack = new Stack<Object>(); |
aoqi@0 | 42 | |
aoqi@0 | 43 | private String indentStep = " "; |
aoqi@0 | 44 | private int depth = 0; |
aoqi@0 | 45 | |
aoqi@0 | 46 | public IndentingXMLStreamWriter(XMLStreamWriter writer) { |
aoqi@0 | 47 | super(writer); |
aoqi@0 | 48 | } |
aoqi@0 | 49 | |
aoqi@0 | 50 | /** |
aoqi@0 | 51 | * Return the current indent step. |
aoqi@0 | 52 | * |
aoqi@0 | 53 | * <p>Return the current indent step: each start tag will be |
aoqi@0 | 54 | * indented by this number of spaces times the number of |
aoqi@0 | 55 | * ancestors that the element has.</p> |
aoqi@0 | 56 | * |
aoqi@0 | 57 | * @return The number of spaces in each indentation step, |
aoqi@0 | 58 | * or 0 or less for no indentation. |
aoqi@0 | 59 | * @see #setIndentStep(int) |
aoqi@0 | 60 | * |
aoqi@0 | 61 | * @deprecated |
aoqi@0 | 62 | * Only return the length of the indent string. |
aoqi@0 | 63 | */ |
aoqi@0 | 64 | public int getIndentStep() { |
aoqi@0 | 65 | return indentStep.length(); |
aoqi@0 | 66 | } |
aoqi@0 | 67 | |
aoqi@0 | 68 | |
aoqi@0 | 69 | /** |
aoqi@0 | 70 | * Set the current indent step. |
aoqi@0 | 71 | * |
aoqi@0 | 72 | * @param indentStep The new indent step (0 or less for no |
aoqi@0 | 73 | * indentation). |
aoqi@0 | 74 | * @see #getIndentStep() |
aoqi@0 | 75 | * |
aoqi@0 | 76 | * @deprecated |
aoqi@0 | 77 | * Should use the version that takes string. |
aoqi@0 | 78 | */ |
aoqi@0 | 79 | public void setIndentStep(int indentStep) { |
aoqi@0 | 80 | StringBuilder s = new StringBuilder(); |
aoqi@0 | 81 | for (; indentStep > 0; indentStep--) s.append(' '); |
aoqi@0 | 82 | setIndentStep(s.toString()); |
aoqi@0 | 83 | } |
aoqi@0 | 84 | |
aoqi@0 | 85 | public void setIndentStep(String s) { |
aoqi@0 | 86 | this.indentStep = s; |
aoqi@0 | 87 | } |
aoqi@0 | 88 | |
aoqi@0 | 89 | private void onStartElement() throws XMLStreamException { |
aoqi@0 | 90 | stateStack.push(SEEN_ELEMENT); |
aoqi@0 | 91 | state = SEEN_NOTHING; |
aoqi@0 | 92 | if (depth > 0) { |
aoqi@0 | 93 | super.writeCharacters("\n"); |
aoqi@0 | 94 | } |
aoqi@0 | 95 | doIndent(); |
aoqi@0 | 96 | depth++; |
aoqi@0 | 97 | } |
aoqi@0 | 98 | |
aoqi@0 | 99 | private void onEndElement() throws XMLStreamException { |
aoqi@0 | 100 | depth--; |
aoqi@0 | 101 | if (state == SEEN_ELEMENT) { |
aoqi@0 | 102 | super.writeCharacters("\n"); |
aoqi@0 | 103 | doIndent(); |
aoqi@0 | 104 | } |
aoqi@0 | 105 | state = stateStack.pop(); |
aoqi@0 | 106 | } |
aoqi@0 | 107 | |
aoqi@0 | 108 | private void onEmptyElement() throws XMLStreamException { |
aoqi@0 | 109 | state = SEEN_ELEMENT; |
aoqi@0 | 110 | if (depth > 0) { |
aoqi@0 | 111 | super.writeCharacters("\n"); |
aoqi@0 | 112 | } |
aoqi@0 | 113 | doIndent(); |
aoqi@0 | 114 | } |
aoqi@0 | 115 | |
aoqi@0 | 116 | /** |
aoqi@0 | 117 | * Print indentation for the current level. |
aoqi@0 | 118 | * |
aoqi@0 | 119 | * @exception org.xml.sax.SAXException If there is an error |
aoqi@0 | 120 | * writing the indentation characters, or if a filter |
aoqi@0 | 121 | * further down the chain raises an exception. |
aoqi@0 | 122 | */ |
aoqi@0 | 123 | private void doIndent() throws XMLStreamException { |
aoqi@0 | 124 | if (depth > 0) { |
aoqi@0 | 125 | for (int i = 0; i < depth; i++) |
aoqi@0 | 126 | super.writeCharacters(indentStep); |
aoqi@0 | 127 | } |
aoqi@0 | 128 | } |
aoqi@0 | 129 | |
aoqi@0 | 130 | |
aoqi@0 | 131 | public void writeStartDocument() throws XMLStreamException { |
aoqi@0 | 132 | super.writeStartDocument(); |
aoqi@0 | 133 | super.writeCharacters("\n"); |
aoqi@0 | 134 | } |
aoqi@0 | 135 | |
aoqi@0 | 136 | public void writeStartDocument(String version) throws XMLStreamException { |
aoqi@0 | 137 | super.writeStartDocument(version); |
aoqi@0 | 138 | super.writeCharacters("\n"); |
aoqi@0 | 139 | } |
aoqi@0 | 140 | |
aoqi@0 | 141 | public void writeStartDocument(String encoding, String version) throws XMLStreamException { |
aoqi@0 | 142 | super.writeStartDocument(encoding, version); |
aoqi@0 | 143 | super.writeCharacters("\n"); |
aoqi@0 | 144 | } |
aoqi@0 | 145 | |
aoqi@0 | 146 | public void writeStartElement(String localName) throws XMLStreamException { |
aoqi@0 | 147 | onStartElement(); |
aoqi@0 | 148 | super.writeStartElement(localName); |
aoqi@0 | 149 | } |
aoqi@0 | 150 | |
aoqi@0 | 151 | public void writeStartElement(String namespaceURI, String localName) throws XMLStreamException { |
aoqi@0 | 152 | onStartElement(); |
aoqi@0 | 153 | super.writeStartElement(namespaceURI, localName); |
aoqi@0 | 154 | } |
aoqi@0 | 155 | |
aoqi@0 | 156 | public void writeStartElement(String prefix, String localName, String namespaceURI) throws XMLStreamException { |
aoqi@0 | 157 | onStartElement(); |
aoqi@0 | 158 | super.writeStartElement(prefix, localName, namespaceURI); |
aoqi@0 | 159 | } |
aoqi@0 | 160 | |
aoqi@0 | 161 | public void writeEmptyElement(String namespaceURI, String localName) throws XMLStreamException { |
aoqi@0 | 162 | onEmptyElement(); |
aoqi@0 | 163 | super.writeEmptyElement(namespaceURI, localName); |
aoqi@0 | 164 | } |
aoqi@0 | 165 | |
aoqi@0 | 166 | public void writeEmptyElement(String prefix, String localName, String namespaceURI) throws XMLStreamException { |
aoqi@0 | 167 | onEmptyElement(); |
aoqi@0 | 168 | super.writeEmptyElement(prefix, localName, namespaceURI); |
aoqi@0 | 169 | } |
aoqi@0 | 170 | |
aoqi@0 | 171 | public void writeEmptyElement(String localName) throws XMLStreamException { |
aoqi@0 | 172 | onEmptyElement(); |
aoqi@0 | 173 | super.writeEmptyElement(localName); |
aoqi@0 | 174 | } |
aoqi@0 | 175 | |
aoqi@0 | 176 | public void writeEndElement() throws XMLStreamException { |
aoqi@0 | 177 | onEndElement(); |
aoqi@0 | 178 | super.writeEndElement(); |
aoqi@0 | 179 | } |
aoqi@0 | 180 | |
aoqi@0 | 181 | public void writeCharacters(String text) throws XMLStreamException { |
aoqi@0 | 182 | state = SEEN_DATA; |
aoqi@0 | 183 | super.writeCharacters(text); |
aoqi@0 | 184 | } |
aoqi@0 | 185 | |
aoqi@0 | 186 | public void writeCharacters(char[] text, int start, int len) throws XMLStreamException { |
aoqi@0 | 187 | state = SEEN_DATA; |
aoqi@0 | 188 | super.writeCharacters(text, start, len); |
aoqi@0 | 189 | } |
aoqi@0 | 190 | |
aoqi@0 | 191 | public void writeCData(String data) throws XMLStreamException { |
aoqi@0 | 192 | state = SEEN_DATA; |
aoqi@0 | 193 | super.writeCData(data); |
aoqi@0 | 194 | } |
aoqi@0 | 195 | } |