1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
/* * The contents of this file are subject to the terms * of the Common Development and Distribution License * (the "License"). You may not use this file except * in compliance with the License. * * You can obtain a copy of the license at * https://jaxp.dev.java.net/CDDLv1.0.html. * See the License for the specific language governing * permissions and limitations under the License. * * When distributing Covered Code, include this CDDL * HEADER in each file and include the License file at * https://jaxp.dev.java.net/CDDLv1.0.html * If applicable add the following below this CDDL HEADER * with the fields enclosed by brackets "[]" replaced with * your own identifying information: Portions Copyright * [year] [name of copyright owner] */ /* * $Id: StAXSource.java,v 1.4 2006/04/24 13:42:27 ndw Exp $ * @(#)StAXSource.java 1.11 06/07/13 * * Copyright 2005 Sun Microsystems, Inc. All Rights Reserved. */ package javax.xml.transform.stax; import javax.xml.stream.XMLEventReader; import javax.xml.stream.XMLStreamConstants; import javax.xml.stream.XMLStreamException; import javax.xml.stream.XMLStreamReader; import javax.xml.stream.events.XMLEvent; import javax.xml.transform.Source; /** * <p>Acts as a holder for an XML {@link Source} in the * form of a StAX reader,i.e. * {@link XMLStreamReader} or {@link XMLEventReader}. * <code>StAXSource</code> can be used in all cases that accept * a <code>Source</code>, e.g. {@link javax.xml.transform.Transformer}, * {@link javax.xml.validation.Validator} which accept * <code>Source</code> as input. * * <p><code>StAXSource</code>s are consumed during processing * and are not reusable.</p> * * @author <a href="mailto:Neeraj.Bajaj@Sun.com">Neeraj Bajaj</a> * @author <a href="mailto:Jeff.Suttor@Sun.com">Jeff Suttor</a> * @version $Revision: 1.4 $, $Date: 2006/04/24 13:42:27 $ * * @see <a href="http://jcp.org/en/jsr/detail?id=173"> * JSR 173: Streaming API for XML</a> * @see XMLStreamReader * @see XMLEventReader * * @since 1.6 */ public class StAXSource implements Source { /** If {@link javax.xml.transform.TransformerFactory#getFeature(String name)} * returns true when passed this value as an argument, * the Transformer supports Source input of this type. */ public static final String FEATURE = "http://javax.xml.transform.stax.StAXSource/feature"; /** <p><code>XMLEventReader</code> to be used for source input.</p> */ private XMLEventReader xmlEventReader = null; /** <p><code>XMLStreamReader</code> to be used for source input.</p> */ private XMLStreamReader xmlStreamReader = null; /** <p>System identifier of source input.</p> */ private String systemId = null; /** * <p>Creates a new instance of a <code>StAXSource</code> * by supplying an {@link XMLEventReader}.</p> * * <p><code>XMLEventReader</code> must be a * non-<code>null</code> reference.</p> * * <p><code>XMLEventReader</code> must be in * {@link XMLStreamConstants#START_DOCUMENT} or * {@link XMLStreamConstants#START_ELEMENT} state.</p> * * @param xmlEventReader <code>XMLEventReader</code> used to create * this <code>StAXSource</code>. * * @throws XMLStreamException If <code>xmlEventReader</code> access * throws an <code>Exception</code>. * @throws IllegalArgumentException If <code>xmlEventReader</code> == * <code>null</code>. * @throws IllegalStateException If <code>xmlEventReader</code> * is not in <code>XMLStreamConstants.START_DOCUMENT</code> or * <code>XMLStreamConstants.START_ELEMENT</code> state. */ public StAXSource(final XMLEventReader xmlEventReader) throws XMLStreamException { if (xmlEventReader == null) { throw new IllegalArgumentException( "StAXSource(XMLEventReader) with XMLEventReader == null"); } // TODO: This is ugly ... // there is no way to know the current position(event) of // XMLEventReader. peek() is the only way to know the next event. // The next event on the input stream should be // XMLStreamConstants.START_DOCUMENT or // XMLStreamConstants.START_ELEMENT. XMLEvent event = xmlEventReader.peek(); int eventType = event.getEventType(); if (eventType != XMLStreamConstants.START_DOCUMENT && eventType != XMLStreamConstants.START_ELEMENT) { throw new IllegalStateException( "StAXSource(XMLEventReader) with XMLEventReader " + "not in XMLStreamConstants.START_DOCUMENT or " + "XMLStreamConstants.START_ELEMENT state"); } this.xmlEventReader = xmlEventReader; systemId = event.getLocation().getSystemId(); } /** * <p>Creates a new instance of a <code>StAXSource</code> * by supplying an {@link XMLStreamReader}.</p> * * <p><code>XMLStreamReader</code> must be a * non-<code>null</code> reference.</p> * * <p><code>XMLStreamReader</code> must be in * {@link XMLStreamConstants#START_DOCUMENT} or * {@link XMLStreamConstants#START_ELEMENT} state.</p> * * @param xmlStreamReader <code>XMLStreamReader</code> used to create * this <code>StAXSource</code>. * * @throws IllegalArgumentException If <code>xmlStreamReader</code> == * <code>null</code>. * @throws IllegalStateException If <code>xmlStreamReader</code> * is not in <code>XMLStreamConstants.START_DOCUMENT</code> or * <code>XMLStreamConstants.START_ELEMENT</code> state. */ public StAXSource(final XMLStreamReader xmlStreamReader) { if (xmlStreamReader == null) { throw new IllegalArgumentException( "StAXSource(XMLStreamReader) with XMLStreamReader == null"); } int eventType = xmlStreamReader.getEventType(); if (eventType != XMLStreamConstants.START_DOCUMENT && eventType != XMLStreamConstants.START_ELEMENT) { throw new IllegalStateException( "StAXSource(XMLStreamReader) with XMLStreamReader" + "not in XMLStreamConstants.START_DOCUMENT or " + "XMLStreamConstants.START_ELEMENT state"); } this.xmlStreamReader = xmlStreamReader; systemId = xmlStreamReader.getLocation().getSystemId(); } /** * <p>Get the <code>XMLEventReader</code> used by this * <code>StAXSource</code>.</p> * * <p><code>XMLEventReader</code> will be <code>null</code>. * if this <code>StAXSource</code> was created with a * <code>XMLStreamReader</code>.</p> * * @return <code>XMLEventReader</code> used by this * <code>StAXSource</code>. */ public XMLEventReader getXMLEventReader() { return xmlEventReader; } /** * <p>Get the <code>XMLStreamReader</code> used by this * <code>StAXSource</code>.</p> * * <p><code>XMLStreamReader</code> will be <code>null</code> * if this <code>StAXSource</code> was created with a * <code>XMLEventReader</code>.</p> * * @return <code>XMLStreamReader</code> used by this * <code>StAXSource</code>. */ public XMLStreamReader getXMLStreamReader() { return xmlStreamReader; } /** * <p>In the context of a <code>StAXSource</code>, it is not appropriate * to explicitly set the system identifier. * The <code>XMLStreamReader</code> or <code>XMLEventReader</code> * used to construct this <code>StAXSource</code> determines the * system identifier of the XML source.</p> * * <p>An {@link UnsupportedOperationException} is <strong>always</strong> * thrown by this method.</p> * * @param systemId Ignored. * * @throws UnsupportedOperationException Is <strong>always</strong> * thrown by this method. */ public void setSystemId(final String systemId) { throw new UnsupportedOperationException( "StAXSource#setSystemId(systemId) cannot set the " + "system identifier for a StAXSource"); } /** * <p>Get the system identifier used by this * <code>StAXSource</code>.</p> * * <p>The <code>XMLStreamReader</code> or <code>XMLEventReader</code> * used to construct this <code>StAXSource</code> is queried to determine * the system identifier of the XML source.</p> * * <p>The system identifier may be <code>null</code> or * an empty <code>""</code> <code>String</code>.</p> * * @return System identifier used by this <code>StAXSource</code>. */ public String getSystemId() { return systemId; } }