org.apache.xmlbeans.impl.richParser.XMLStreamReaderExt Maven / Gradle / Ivy
/* Copyright 2004 The Apache Software Foundation
*
* 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.apache.xmlbeans.impl.richParser;
import org.apache.xmlbeans.GDate;
import org.apache.xmlbeans.GDuration;
import org.apache.xmlbeans.XmlCalendar;
import org.apache.xmlbeans.impl.common.XmlWhitespace;
import javax.xml.stream.XMLStreamReader;
import javax.xml.stream.XMLStreamException;
import javax.xml.namespace.QName;
import java.math.BigInteger;
import java.math.BigDecimal;
import java.util.Date;
import java.io.InputStream;
/**
* This interface extends the simple XMLStreamReader interface adding
* methods to get java objects asociated with schemas simple types like:
* ints, long, BigIntegers, Dates etc
*
* Note: Given the fact that an implemetation of this interface will not
* run validation in the stream, we will not include support for lists,
* enumeration and unions. They might be possible to introduce but the
* user has to push the corect schema type. Because usualy the backends
* are not list/union aware, there would be not performance win from this.
* If interest rises for this, support should be added.
*
* Author: Cezar Andrei (cezar.andrei at bea.com)
* Date: Nov 14, 2003
*/
public interface XMLStreamReaderExt
extends XMLStreamReader
{
public static final int WS_PRESERVE = XmlWhitespace.WS_PRESERVE;
public static final int WS_REPLACE = XmlWhitespace.WS_REPLACE;
public static final int WS_COLLAPSE = XmlWhitespace.WS_COLLAPSE;
/** Returns the value as a {@link String}. */
public String getStringValue() throws XMLStreamException;
/** Returns the value as a {@link String}, with wsStyle applied. */
public String getStringValue(int wsStyle) throws XMLStreamException;
/** Returns the value as a boolean. */
public boolean getBooleanValue() throws XMLStreamException;
/** Returns the value as a byte. */
public byte getByteValue() throws XMLStreamException;
/** Returns the value as a short. */
public short getShortValue() throws XMLStreamException;
/** Returns the value as an int. */
public int getIntValue() throws XMLStreamException;
/** Returns the value as a long. */
public long getLongValue() throws XMLStreamException;
/** Returns the value as a {@link java.math.BigInteger}. */
public BigInteger getBigIntegerValue() throws XMLStreamException;
/** Returns the value as a {@link java.math.BigDecimal}. */
public BigDecimal getBigDecimalValue() throws XMLStreamException;
/** Returns the value as a float. */
public float getFloatValue() throws XMLStreamException;
/** Returns the value as a double. */
public double getDoubleValue() throws XMLStreamException;
/** Returns the decoded hexbinary value as an InputStream. */
public InputStream getHexBinaryValue() throws XMLStreamException;
/** Returns the decoded base64 value as anInputStream. */
public InputStream getBase64Value() throws XMLStreamException;
/** Returns the value as an XmlCalendar which extends {@link java.util.Calendar}. */
public XmlCalendar getCalendarValue() throws XMLStreamException;
/** Returns the value as a {@link java.util.Date}. */
public Date getDateValue() throws XMLStreamException;
/** Returns the value as a {@link org.apache.xmlbeans.GDate}. */
public GDate getGDateValue() throws XMLStreamException;
/** Returns the value as a {@link org.apache.xmlbeans.GDuration}. */
public GDuration getGDurationValue() throws XMLStreamException;
/** Returns the value as a {@link javax.xml.namespace.QName}. */
public QName getQNameValue() throws XMLStreamException;
/** Returns the value as a {@link String}. */
public String getAttributeStringValue(int index) throws XMLStreamException;
/** Returns the value as a {@link String}, with wsStyle applied. */
public String getAttributeStringValue(int index, int wsStyle) throws XMLStreamException;
/** Returns the value as a boolean. */
public boolean getAttributeBooleanValue(int index) throws XMLStreamException;
/** Returns the value as a byte. */
public byte getAttributeByteValue(int index) throws XMLStreamException;
/** Returns the value as a short. */
public short getAttributeShortValue(int index) throws XMLStreamException;
/** Returns the value as an int. */
public int getAttributeIntValue(int index) throws XMLStreamException;
/** Returns the value as a long. */
public long getAttributeLongValue(int index) throws XMLStreamException;
/** Returns the value as a {@link java.math.BigInteger}. */
public BigInteger getAttributeBigIntegerValue(int index) throws XMLStreamException;
/** Returns the value as a {@link java.math.BigDecimal}. */
public BigDecimal getAttributeBigDecimalValue(int index) throws XMLStreamException;
/** Returns the value as a float. */
public float getAttributeFloatValue(int index) throws XMLStreamException;
/** Returns the value as a double. */
public double getAttributeDoubleValue(int index) throws XMLStreamException;
/** Returns the decoded hexbinary value as an InputStream. */
public InputStream getAttributeHexBinaryValue(int index) throws XMLStreamException;
/** Returns the decoded base64 value as anInputStream. */
public InputStream getAttributeBase64Value(int index) throws XMLStreamException;
/** Returns the value as an XmlCalendar which extends {@link java.util.Calendar}. */
public XmlCalendar getAttributeCalendarValue(int index) throws XMLStreamException;
/** Returns the value as a {@link java.util.Date}. */
public Date getAttributeDateValue(int index) throws XMLStreamException;
/** Returns the value as a {@link org.apache.xmlbeans.GDate}. */
public GDate getAttributeGDateValue(int index) throws XMLStreamException;
/** Returns the value as a {@link org.apache.xmlbeans.GDuration}. */
public GDuration getAttributeGDurationValue(int index) throws XMLStreamException;
/** Returns the value as a {@link javax.xml.namespace.QName}. */
public QName getAttributeQNameValue(int index) throws XMLStreamException;
/** Returns the value as a {@link String}. */
public String getAttributeStringValue(String uri, String local) throws XMLStreamException;
/** Returns the value as a {@link String}, with wsStyle applied. */
public String getAttributeStringValue(String uri, String local, int wsStyle) throws XMLStreamException;
/** Returns the value as a boolean. */
public boolean getAttributeBooleanValue(String uri, String local) throws XMLStreamException;
/** Returns the value as a byte. */
public byte getAttributeByteValue(String uri, String local) throws XMLStreamException;
/** Returns the value as a short. */
public short getAttributeShortValue(String uri, String local) throws XMLStreamException;
/** Returns the value as an int. */
public int getAttributeIntValue(String uri, String local) throws XMLStreamException;
/** Returns the value as a long. */
public long getAttributeLongValue(String uri, String local) throws XMLStreamException;
/** Returns the value as a {@link java.math.BigInteger}. */
public BigInteger getAttributeBigIntegerValue(String uri, String local) throws XMLStreamException;
/** Returns the value as a {@link java.math.BigDecimal}. */
public BigDecimal getAttributeBigDecimalValue(String uri, String local) throws XMLStreamException;
/** Returns the value as a float. */
public float getAttributeFloatValue(String uri, String local) throws XMLStreamException;
/** Returns the value as a double. */
public double getAttributeDoubleValue(String uri, String local) throws XMLStreamException;
/** Returns the decoded hexbinary value as an InputStream. */
public InputStream getAttributeHexBinaryValue(String uri, String local) throws XMLStreamException;
/** Returns the decoded base64 value as anInputStream. */
public InputStream getAttributeBase64Value(String uri, String local) throws XMLStreamException;
/** Returns the value as an XmlCalendar which extends {@link java.util.Calendar}. */
public XmlCalendar getAttributeCalendarValue(String uri, String local) throws XMLStreamException;
/** Returns the value as a {@link java.util.Date}. */
public Date getAttributeDateValue(String uri, String local) throws XMLStreamException;
/** Returns the value as a {@link org.apache.xmlbeans.GDate}. */
public GDate getAttributeGDateValue(String uri, String local) throws XMLStreamException;
/** Returns the value as a {@link org.apache.xmlbeans.GDuration}. */
public GDuration getAttributeGDurationValue(String uri, String local) throws XMLStreamException;
/** Returns the value as a {@link javax.xml.namespace.QName}. */
public QName getAttributeQNameValue(String uri, String local) throws XMLStreamException;
/** Sets the default value for the next getXXXValue() call.
* For example:
* setDefaultValue("7");
* //the xml looks like:
* int i = getIntValue(); // returns 7
* // from now on the default value will not apply anymore
* Note: Works for getAttributeXXXValue(...) too.
*/
public void setDefaultValue(String defaultValue) throws XMLStreamException;
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy