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) 1997, 2011, 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.bind.v2.runtime.output; |
aoqi@0 | 27 | |
aoqi@0 | 28 | import com.sun.xml.internal.bind.marshaller.CharacterEscapeHandler; |
aoqi@0 | 29 | import java.io.IOException; |
aoqi@0 | 30 | import java.io.OutputStream; |
aoqi@0 | 31 | |
aoqi@0 | 32 | import javax.xml.stream.XMLStreamException; |
aoqi@0 | 33 | |
aoqi@0 | 34 | import com.sun.xml.internal.bind.v2.runtime.Name; |
aoqi@0 | 35 | |
aoqi@0 | 36 | import org.xml.sax.SAXException; |
aoqi@0 | 37 | |
aoqi@0 | 38 | /** |
aoqi@0 | 39 | * {@link UTF8XmlOutput} with indentation. |
aoqi@0 | 40 | * |
aoqi@0 | 41 | * TODO: not sure if it's a good idea to move the indenting functionality to another class. |
aoqi@0 | 42 | * |
aoqi@0 | 43 | * Doesn't have to be final, but it helps the JVM. |
aoqi@0 | 44 | * |
aoqi@0 | 45 | * @author Kohsuke Kawaguchi |
aoqi@0 | 46 | */ |
aoqi@0 | 47 | public final class IndentingUTF8XmlOutput extends UTF8XmlOutput { |
aoqi@0 | 48 | |
aoqi@0 | 49 | /** |
aoqi@0 | 50 | * Null if the writer should perform no indentation. |
aoqi@0 | 51 | * |
aoqi@0 | 52 | * Otherwise this will keep the 8 copies of the string for indentation. |
aoqi@0 | 53 | * (so that we can write 8 indentation at once.) |
aoqi@0 | 54 | */ |
aoqi@0 | 55 | private final Encoded indent8; |
aoqi@0 | 56 | |
aoqi@0 | 57 | /** |
aoqi@0 | 58 | * Length of one indentation. |
aoqi@0 | 59 | */ |
aoqi@0 | 60 | private final int unitLen; |
aoqi@0 | 61 | |
aoqi@0 | 62 | private int depth = 0; |
aoqi@0 | 63 | |
aoqi@0 | 64 | private boolean seenText = false; |
aoqi@0 | 65 | |
aoqi@0 | 66 | /** |
aoqi@0 | 67 | * |
aoqi@0 | 68 | * @param indentStr |
aoqi@0 | 69 | * set to null for no indentation and optimal performance. |
aoqi@0 | 70 | * otherwise the string is used for indentation. |
aoqi@0 | 71 | */ |
aoqi@0 | 72 | public IndentingUTF8XmlOutput(OutputStream out, String indentStr, Encoded[] localNames, CharacterEscapeHandler escapeHandler) { |
aoqi@0 | 73 | super(out, localNames, escapeHandler); |
aoqi@0 | 74 | |
aoqi@0 | 75 | if(indentStr!=null) { |
aoqi@0 | 76 | Encoded e = new Encoded(indentStr); |
aoqi@0 | 77 | indent8 = new Encoded(); |
aoqi@0 | 78 | indent8.ensureSize(e.len*8); |
aoqi@0 | 79 | unitLen = e.len; |
aoqi@0 | 80 | for( int i=0; i<8; i++ ) |
aoqi@0 | 81 | System.arraycopy(e.buf, 0, indent8.buf, unitLen*i, unitLen); |
aoqi@0 | 82 | } else { |
aoqi@0 | 83 | this.indent8 = null; |
aoqi@0 | 84 | this.unitLen = 0; |
aoqi@0 | 85 | } |
aoqi@0 | 86 | } |
aoqi@0 | 87 | |
aoqi@0 | 88 | @Override |
aoqi@0 | 89 | public void beginStartTag(int prefix, String localName) throws IOException { |
aoqi@0 | 90 | indentStartTag(); |
aoqi@0 | 91 | super.beginStartTag(prefix, localName); |
aoqi@0 | 92 | } |
aoqi@0 | 93 | |
aoqi@0 | 94 | @Override |
aoqi@0 | 95 | public void beginStartTag(Name name) throws IOException { |
aoqi@0 | 96 | indentStartTag(); |
aoqi@0 | 97 | super.beginStartTag(name); |
aoqi@0 | 98 | } |
aoqi@0 | 99 | |
aoqi@0 | 100 | private void indentStartTag() throws IOException { |
aoqi@0 | 101 | closeStartTag(); |
aoqi@0 | 102 | if(!seenText) |
aoqi@0 | 103 | printIndent(); |
aoqi@0 | 104 | depth++; |
aoqi@0 | 105 | seenText = false; |
aoqi@0 | 106 | } |
aoqi@0 | 107 | |
aoqi@0 | 108 | @Override |
aoqi@0 | 109 | public void endTag(Name name) throws IOException { |
aoqi@0 | 110 | indentEndTag(); |
aoqi@0 | 111 | super.endTag(name); |
aoqi@0 | 112 | } |
aoqi@0 | 113 | |
aoqi@0 | 114 | @Override |
aoqi@0 | 115 | public void endTag(int prefix, String localName) throws IOException { |
aoqi@0 | 116 | indentEndTag(); |
aoqi@0 | 117 | super.endTag(prefix, localName); |
aoqi@0 | 118 | } |
aoqi@0 | 119 | |
aoqi@0 | 120 | private void indentEndTag() throws IOException { |
aoqi@0 | 121 | depth--; |
aoqi@0 | 122 | if(!closeStartTagPending && !seenText) |
aoqi@0 | 123 | printIndent(); |
aoqi@0 | 124 | seenText = false; |
aoqi@0 | 125 | } |
aoqi@0 | 126 | |
aoqi@0 | 127 | private void printIndent() throws IOException { |
aoqi@0 | 128 | write('\n'); |
aoqi@0 | 129 | int i = depth%8; |
aoqi@0 | 130 | |
aoqi@0 | 131 | write( indent8.buf, 0, i*unitLen ); |
aoqi@0 | 132 | |
aoqi@0 | 133 | i>>=3; // really i /= 8; |
aoqi@0 | 134 | |
aoqi@0 | 135 | for( ; i>0; i-- ) |
aoqi@0 | 136 | indent8.write(this); |
aoqi@0 | 137 | } |
aoqi@0 | 138 | |
aoqi@0 | 139 | @Override |
aoqi@0 | 140 | public void text(String value, boolean needSP) throws IOException { |
aoqi@0 | 141 | seenText = true; |
aoqi@0 | 142 | super.text(value, needSP); |
aoqi@0 | 143 | } |
aoqi@0 | 144 | |
aoqi@0 | 145 | @Override |
aoqi@0 | 146 | public void text(Pcdata value, boolean needSP) throws IOException { |
aoqi@0 | 147 | seenText = true; |
aoqi@0 | 148 | super.text(value, needSP); |
aoqi@0 | 149 | } |
aoqi@0 | 150 | |
aoqi@0 | 151 | @Override |
aoqi@0 | 152 | public void endDocument(boolean fragment) throws IOException, SAXException, XMLStreamException { |
aoqi@0 | 153 | write('\n'); |
aoqi@0 | 154 | super.endDocument(fragment); |
aoqi@0 | 155 | } |
aoqi@0 | 156 | } |