https://github.com/spring-projects/spring-framework: Spring Core (Spring IO)
  • Juergen Hoeller 
/*
 * Copyright 2002-2017 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.util.xml;

import javax.xml.stream.XMLEventWriter;
import javax.xml.stream.XMLStreamWriter;
import javax.xml.transform.sax.SAXResult;

import org.xml.sax.ContentHandler;
import org.xml.sax.ext.LexicalHandler;

import org.springframework.lang.Nullable;


Implementation of the Result tagging interface for StAX writers. Can be constructed with an XMLEventConsumer or an XMLStreamWriter. 
This class is necessary because there is no implementation of Source for StaxReaders in JAXP 1.3. There is a StAXResult in JAXP 1.4 (JDK 1.6), but this class is kept around for backwards compatibility reasons. 
Even though StaxResult extends from SAXResult, calling the methods of SAXResult is not supported. In general, the only supported operation on this class is to use the ContentHandler obtained via SAXResult.getHandler() to parse an input source using an XMLReader. Calling setHandler(ContentHandler) or setLexicalHandler(LexicalHandler) will result in UnsupportedOperationExceptions. 
Author:Arjen Poutsma
See Also:
Since:3.0
/**
 * Implementation of the {@code Result} tagging interface for StAX writers. Can be constructed with
 * an {@code XMLEventConsumer} or an {@code XMLStreamWriter}.
 *
 * <p>This class is necessary because there is no implementation of {@code Source} for StaxReaders
 * in JAXP 1.3. There is a {@code StAXResult} in JAXP 1.4 (JDK 1.6), but this class is kept around
 * for backwards compatibility reasons.
 *
 * <p>Even though {@code StaxResult} extends from {@code SAXResult}, calling the methods of
 * {@code SAXResult} is <strong>not supported</strong>. In general, the only supported operation
 * on this class is to use the {@code ContentHandler} obtained via {@link #getHandler()} to parse an
 * input source using an {@code XMLReader}. Calling {@link #setHandler(org.xml.sax.ContentHandler)}
 * or {@link #setLexicalHandler(org.xml.sax.ext.LexicalHandler)} will result in
 * {@code UnsupportedOperationException}s.
 *
 * @author Arjen Poutsma
 * @since 3.0
 * @see XMLEventWriter
 * @see XMLStreamWriter
 * @see javax.xml.transform.Transformer
 */
class StaxResult extends SAXResult {

	@Nullable
	private XMLEventWriter eventWriter;

	@Nullable
	private XMLStreamWriter streamWriter;


	
Construct a new instance of the StaxResult with the specified XMLEventWriter. 
Params:
  • eventWriter – the XMLEventWriter to write to
/**
	 * Construct a new instance of the {@code StaxResult} with the specified {@code XMLEventWriter}.
	 * @param eventWriter the {@code XMLEventWriter} to write to
	 */
	public StaxResult(XMLEventWriter eventWriter) {
		StaxEventHandler handler = new StaxEventHandler(eventWriter);
		super.setHandler(handler);
		super.setLexicalHandler(handler);
		this.eventWriter = eventWriter;
	}

	
Construct a new instance of the StaxResult with the specified XMLStreamWriter. 
Params:
  • streamWriter – the XMLStreamWriter to write to
/**
	 * Construct a new instance of the {@code StaxResult} with the specified {@code XMLStreamWriter}.
	 * @param streamWriter the {@code XMLStreamWriter} to write to
	 */
	public StaxResult(XMLStreamWriter streamWriter) {
		StaxStreamHandler handler = new StaxStreamHandler(streamWriter);
		super.setHandler(handler);
		super.setLexicalHandler(handler);
		this.streamWriter = streamWriter;
	}


	
Return the XMLEventWriter used by this StaxResult. 
If this StaxResult was created with an XMLStreamWriter, the result will be null. 
See Also:
Returns:the StAX event writer used by this result
/**
	 * Return the {@code XMLEventWriter} used by this {@code StaxResult}.
	 * <p>If this {@code StaxResult} was created with an {@code XMLStreamWriter},
	 * the result will be {@code null}.
	 * @return the StAX event writer used by this result
	 * @see #StaxResult(javax.xml.stream.XMLEventWriter)
	 */
	@Nullable
	public XMLEventWriter getXMLEventWriter() {
		return this.eventWriter;
	}

	
Return the XMLStreamWriter used by this StaxResult. 
If this StaxResult was created with an XMLEventConsumer, the result will be null. 
See Also:
Returns:the StAX stream writer used by this result
/**
	 * Return the {@code XMLStreamWriter} used by this {@code StaxResult}.
	 * <p>If this {@code StaxResult} was created with an {@code XMLEventConsumer},
	 * the result will be {@code null}.
	 * @return the StAX stream writer used by this result
	 * @see #StaxResult(javax.xml.stream.XMLStreamWriter)
	 */
	@Nullable
	public XMLStreamWriter getXMLStreamWriter() {
		return this.streamWriter;
	}


	
Throws an UnsupportedOperationException. 
Throws:
/**
	 * Throws an {@code UnsupportedOperationException}.
	 * @throws UnsupportedOperationException always
	 */
	@Override
	public void setHandler(ContentHandler handler) {
		throw new UnsupportedOperationException("setHandler is not supported");
	}

	
Throws an UnsupportedOperationException. 
Throws:
/**
	 * Throws an {@code UnsupportedOperationException}.
	 * @throws UnsupportedOperationException always
	 */
	@Override
	public void setLexicalHandler(LexicalHandler handler) {
		throw new UnsupportedOperationException("setLexicalHandler is not supported");
	}

}