/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.ws.util.xml;
import com.sun.xml.ws.api.streaming.XMLStreamReaderFactory;
import javax.xml.namespace.NamespaceContext;
import javax.xml.namespace.QName;
import javax.xml.stream.Location;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
/**
* {@link XMLStreamReader} that delegates to another {@link XMLStreamReader}.
*
* <p>
* This class isn't very useful by itself, but works as a base class
* for {@link XMLStreamReader} filtering.
*
* @author Kohsuke Kawaguchi
*/
public class XMLStreamReaderFilter implements XMLStreamReaderFactory.RecycleAware, XMLStreamReader {
/**
* The underlying {@link XMLStreamReader} that does the parsing of the root part.
*/
protected XMLStreamReader reader;
public XMLStreamReaderFilter(XMLStreamReader core) {
this.reader = core;
}
public void onRecycled() {
XMLStreamReaderFactory.recycle(reader);
reader = null;
}
public int getAttributeCount() {
return reader.getAttributeCount();
}
public int getEventType() {
return reader.getEventType();
}
public int getNamespaceCount() {
return reader.getNamespaceCount();
}
public int getTextLength() {
return reader.getTextLength();
}
public int getTextStart() {
return reader.getTextStart();
}
public int next() throws XMLStreamException {
return reader.next();
}
public int nextTag() throws XMLStreamException {
return reader.nextTag();
}
public void close() throws XMLStreamException {
reader.close();
}
public boolean hasName() {
return reader.hasName();
}
public boolean hasNext() throws XMLStreamException {
return reader.hasNext();
}
public boolean hasText() {
return reader.hasText();
}
public boolean isCharacters() {
return reader.isCharacters();
}
public boolean isEndElement() {
return reader.isEndElement();
}
public boolean isStandalone() {
return reader.isStandalone();
}
public boolean isStartElement() {
return reader.isStartElement();
}
public boolean isWhiteSpace() {
return reader.isWhiteSpace();
}
public boolean standaloneSet() {
return reader.standaloneSet();
}
public char[] getTextCharacters() {
return reader.getTextCharacters();
}
public boolean isAttributeSpecified(int index) {
return reader.isAttributeSpecified(index);
}
public int getTextCharacters(int sourceStart, char[] target, int targetStart, int length) throws XMLStreamException {
return reader.getTextCharacters(sourceStart, target, targetStart, length);
}
public String getCharacterEncodingScheme() {
return reader.getCharacterEncodingScheme();
}
public String getElementText() throws XMLStreamException {
return reader.getElementText();
}
public String getEncoding() {
return reader.getEncoding();
}
public String getLocalName() {
return reader.getLocalName();
}
public String getNamespaceURI() {
return reader.getNamespaceURI();
}
public String getPIData() {
return reader.getPIData();
}
public String getPITarget() {
return reader.getPITarget();
}
public String getPrefix() {
return reader.getPrefix();
}
public String getText() {
return reader.getText();
}
public String getVersion() {
return reader.getVersion();
}
public String getAttributeLocalName(int index) {
return reader.getAttributeLocalName(index);
}
public String getAttributeNamespace(int index) {
return reader.getAttributeNamespace(index);
}
public String getAttributePrefix(int index) {
return reader.getAttributePrefix(index);
}
public String getAttributeType(int index) {
return reader.getAttributeType(index);
}
public String getAttributeValue(int index) {
return reader.getAttributeValue(index);
}
public String getNamespacePrefix(int index) {
return reader.getNamespacePrefix(index);
}
public String getNamespaceURI(int index) {
return reader.getNamespaceURI(index);
}
public NamespaceContext getNamespaceContext() {
return reader.getNamespaceContext();
}
public QName getName() {
return reader.getName();
}
public QName getAttributeName(int index) {
return reader.getAttributeName(index);
}
public Location getLocation() {
return reader.getLocation();
}
public Object getProperty(String name) throws IllegalArgumentException {
return reader.getProperty(name);
}
public void require(int type, String namespaceURI, String localName) throws XMLStreamException {
reader.require(type, namespaceURI, localName);
}
public String getNamespaceURI(String prefix) {
return reader.getNamespaceURI(prefix);
}
public String getAttributeValue(String namespaceURI, String localName) {
return reader.getAttributeValue(namespaceURI, localName);
}
}