/* * Copyright (c) 2005, 2016, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ 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; /** *
Acts as a holder for an XML {@link Source} in the
* form of a StAX reader,i.e.
* {@link XMLStreamReader} or {@link XMLEventReader}.
* StAXSource
can be used in all cases that accept
* a Source
, e.g. {@link javax.xml.transform.Transformer},
* {@link javax.xml.validation.Validator} which accept
* Source
as input.
*
*
StAXSource
s are consumed during processing
* and are not reusable.
XMLEventReader
to be used for source input.
XMLStreamReader
to be used for source input.
System identifier of source input.
*/ private String systemId = null; /** *Creates a new instance of a StAXSource
* by supplying an {@link XMLEventReader}.
XMLEventReader
must be a
* non-null
reference.
XMLEventReader
must be in
* {@link XMLStreamConstants#START_DOCUMENT} or
* {@link XMLStreamConstants#START_ELEMENT} state.
XMLEventReader
used to create
* this StAXSource
.
*
* @throws XMLStreamException If xmlEventReader
access
* throws an Exception
.
* @throws IllegalArgumentException If xmlEventReader
==
* null
.
* @throws IllegalStateException If xmlEventReader
* is not in XMLStreamConstants.START_DOCUMENT
or
* XMLStreamConstants.START_ELEMENT
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();
}
/**
* Creates a new instance of a StAXSource
* by supplying an {@link XMLStreamReader}.
XMLStreamReader
must be a
* non-null
reference.
XMLStreamReader
must be in
* {@link XMLStreamConstants#START_DOCUMENT} or
* {@link XMLStreamConstants#START_ELEMENT} state.
XMLStreamReader
used to create
* this StAXSource
.
*
* @throws IllegalArgumentException If xmlStreamReader
==
* null
.
* @throws IllegalStateException If xmlStreamReader
* is not in XMLStreamConstants.START_DOCUMENT
or
* XMLStreamConstants.START_ELEMENT
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();
}
/**
* Get the XMLEventReader
used by this
* StAXSource
.
XMLEventReader
will be null
.
* if this StAXSource
was created with a
* XMLStreamReader
.
XMLEventReader
used by this
* StAXSource
.
*/
public XMLEventReader getXMLEventReader() {
return xmlEventReader;
}
/**
* Get the XMLStreamReader
used by this
* StAXSource
.
XMLStreamReader
will be null
* if this StAXSource
was created with a
* XMLEventReader
.
XMLStreamReader
used by this
* StAXSource
.
*/
public XMLStreamReader getXMLStreamReader() {
return xmlStreamReader;
}
/**
* In the context of a StAXSource
, it is not appropriate
* to explicitly set the system identifier.
* The XMLStreamReader
or XMLEventReader
* used to construct this StAXSource
determines the
* system identifier of the XML source.
An {@link UnsupportedOperationException} is always * thrown by this method.
* * @param systemId Ignored. * * @throws UnsupportedOperationException Is always * thrown by this method. */ @Override public void setSystemId(final String systemId) { throw new UnsupportedOperationException( "StAXSource#setSystemId(systemId) cannot set the " + "system identifier for a StAXSource"); } /** *Get the system identifier used by this
* StAXSource
.
The XMLStreamReader
or XMLEventReader
* used to construct this StAXSource
is queried to determine
* the system identifier of the XML source.
The system identifier may be null
or
* an empty ""
String
.
StAXSource
.
*/
@Override
public String getSystemId() {
return systemId;
}
/**
* Indicates whether the {@code StAXSource} object is empty. Since a
* {@code StAXSource} object can never be empty, this method always returns
* false.
*
* @return unconditionally false
*/
@Override
public boolean isEmpty() {
return false;
}
}