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
/* * 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: StAXResult.java,v 1.4 2006/04/24 13:42:26 ndw Exp $ * @(#)StAXResult.java 1.11 06/07/13 * * Copyright 2005 Sun Microsystems, Inc. All Rights Reserved. */ package javax.xml.transform.stax; import javax.xml.stream.XMLEventWriter; import javax.xml.stream.XMLStreamWriter; import javax.xml.transform.Result; /** * <p>Acts as a holder for an XML {@link Result} in the * form of a StAX writer,i.e. * {@link XMLStreamWriter} or {@link XMLEventWriter}. * <code>StAXResult</code> can be used in all cases that accept * a <code>Result</code>, e.g. {@link javax.xml.transform.Transformer}, * {@link javax.xml.validation.Validator} which accept * <code>Result</code> as input. * * @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:26 $ * * @see <a href="http://jcp.org/en/jsr/detail?id=173"> * JSR 173: Streaming API for XML</a> * @see XMLStreamWriter * @see XMLEventWriter * * @since 1.6 */ public class StAXResult implements Result { /** If {@link javax.xml.transform.TransformerFactory#getFeature(String name)} * returns true when passed this value as an argument, * the Transformer supports Result output of this type. */ public static final String FEATURE = "http://javax.xml.transform.stax.StAXResult/feature"; /** * <p><code>XMLEventWriter</code> to be used for * <code>Result</code> output.</p> */ private XMLEventWriter xmlEventWriter = null; /** * <p><code>XMLStreamWriter</code> to be used for * <code>Result</code> output.</p> */ private XMLStreamWriter xmlStreamWriter = null; /** <p>System identifier for this <code>StAXResult</code>.<p> */ private String systemId = null; /** * <p>Creates a new instance of a <code>StAXResult</code> * by supplying an {@link XMLEventWriter}.</p> * * <p><code>XMLEventWriter</code> must be a * non-<code>null</code> reference.</p> * * @param xmlEventWriter <code>XMLEventWriter</code> used to create * this <code>StAXResult</code>. * * @throws IllegalArgumentException If <code>xmlEventWriter</code> == * <code>null</code>. */ public StAXResult(final XMLEventWriter xmlEventWriter) { if (xmlEventWriter == null) { throw new IllegalArgumentException( "StAXResult(XMLEventWriter) with XMLEventWriter == null"); } this.xmlEventWriter = xmlEventWriter; } /** * <p>Creates a new instance of a <code>StAXResult</code> * by supplying an {@link XMLStreamWriter}.</p> * * <p><code>XMLStreamWriter</code> must be a * non-<code>null</code> reference.</p> * * @param xmlStreamWriter <code>XMLStreamWriter</code> used to create * this <code>StAXResult</code>. * * @throws IllegalArgumentException If <code>xmlStreamWriter</code> == * <code>null</code>. */ public StAXResult(final XMLStreamWriter xmlStreamWriter) { if (xmlStreamWriter == null) { throw new IllegalArgumentException( "StAXResult(XMLStreamWriter) with XMLStreamWriter == null"); } this.xmlStreamWriter = xmlStreamWriter; } /** * <p>Get the <code>XMLEventWriter</code> used by this * <code>StAXResult</code>.</p> * * <p><code>XMLEventWriter</code> will be <code>null</code> * if this <code>StAXResult</code> was created with a * <code>XMLStreamWriter</code>.</p> * * @return <code>XMLEventWriter</code> used by this * <code>StAXResult</code>. */ public XMLEventWriter getXMLEventWriter() { return xmlEventWriter; } /** * <p>Get the <code>XMLStreamWriter</code> used by this * <code>StAXResult</code>.</p> * * <p><code>XMLStreamWriter</code> will be <code>null</code> * if this <code>StAXResult</code> was created with a * <code>XMLEventWriter</code>.</p> * * @return <code>XMLStreamWriter</code> used by this * <code>StAXResult</code>. */ public XMLStreamWriter getXMLStreamWriter() { return xmlStreamWriter; } /** * <p>In the context of a <code>StAXResult</code>, it is not appropriate * to explicitly set the system identifier. * The <code>XMLEventWriter</code> or <code>XMLStreamWriter</code> * used to construct this <code>StAXResult</code> determines the * system identifier of the XML result.</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( "StAXResult#setSystemId(systemId) cannot set the " + "system identifier for a StAXResult"); } /** * <p>The returned system identifier is always <code>null</code>.</p> * * @return The returned system identifier is always <code>null</code>. */ public String getSystemId() { return null; } }