Home » xmlbeans-2.5.0-src » org.apache » xmlbeans » [javadoc | source]

    1   /*   Copyright 2004 The Apache Software Foundation
    2    *
    3    *   Licensed under the Apache License, Version 2.0 (the "License");
    4    *   you may not use this file except in compliance with the License.
    5    *   You may obtain a copy of the License at
    6    *
    7    *       http://www.apache.org/licenses/LICENSE-2.0
    8    *
    9    *   Unless required by applicable law or agreed to in writing, software
   10    *   distributed under the License is distributed on an "AS IS" BASIS,
   11    *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   12    *   See the License for the specific language governing permissions and
   13    *  limitations under the License.
   14    */
   15   
   16   package org.apache.xmlbeans;
   17   
   18   import javax.xml.stream.XMLStreamReader;
   19   
   20   
   21   import java.util.List;
   22   
   23   
   24   /**
   25    * Corresponds to the XML Schema
   26    * <a target="_blank" href="http://www.w3.org/TR/xmlschema-2/#IDREFS">xs:IDREFS</a> type,
   27    * a list type.
   28    * <p>
   29    * When validated, IDREF values must match an ID value that is present within
   30    * the document. This rule is only verified when a whole document is validated
   31    * at once.
   32    * <p>
   33    * Convertible to a {@link List}. 
   34    */ 
   35   public interface XmlIDREFS extends XmlAnySimpleType
   36   {
   37       /** The constant {@link SchemaType} object representing this schema type. */
   38       public static final SchemaType type = XmlBeans.getBuiltinTypeSystem().typeForHandle("_BI_IDREFS");
   39       
   40       /** Returns the value as a {@link List} of {@link String} values */
   41       List getListValue();
   42       /** Returns the value as a {@link List} of {@link XmlIDREF} values */
   43       List xgetListValue();
   44       /** Sets the value as a {@link List} */
   45       void setListValue(List l);
   46   
   47       /**
   48        * Returns the value as a {@link List} of {@link String} values
   49        * @deprecated replaced by {@link #getListValue}
   50        **/
   51       List listValue();
   52       /**
   53        * Returns the value as a {@link List} of {@link XmlIDREF} values
   54        * @deprecated replaced by {@link #getListValue}
   55        **/
   56       List xlistValue();
   57       /**
   58        * Sets the value as a {@link List}
   59        * @deprecated replaced by {@link #getListValue}
   60        **/
   61       void set(List l);
   62   
   63       /**
   64        * A class with methods for creating instances
   65        * of {@link XmlIDREFS}.
   66        */
   67       public static final class Factory
   68       {
   69           /** Creates an empty instance of {@link XmlIDREFS} */
   70           public static XmlIDREFS newInstance() {
   71             return (XmlIDREFS) XmlBeans.getContextTypeLoader().newInstance( type, null ); }
   72           
   73           /** Creates an empty instance of {@link XmlIDREFS} */
   74           public static XmlIDREFS newInstance(org.apache.xmlbeans.XmlOptions options) {
   75             return (XmlIDREFS) XmlBeans.getContextTypeLoader().newInstance( type, options ); }
   76           
   77           /** Creates an immutable {@link XmlIDREFS} value */
   78           public static XmlIDREFS newValue(Object obj) {
   79             return (XmlIDREFS) type.newValue( obj ); }
   80           
   81           /** Parses a {@link XmlIDREFS} fragment from a String. */
   82           public static XmlIDREFS parse(java.lang.String s) throws org.apache.xmlbeans.XmlException {
   83             return (XmlIDREFS) XmlBeans.getContextTypeLoader().parse( s, type, null ); }
   84           
   85           /** Parses a {@link XmlIDREFS} fragment from a String. */
   86           public static XmlIDREFS parse(java.lang.String s, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException {
   87             return (XmlIDREFS) XmlBeans.getContextTypeLoader().parse( s, type, options ); }
   88           
   89           /** Parses a {@link XmlIDREFS} fragment from a File. */
   90           public static XmlIDREFS parse(java.io.File f) throws org.apache.xmlbeans.XmlException, java.io.IOException {
   91             return (XmlIDREFS) XmlBeans.getContextTypeLoader().parse( f, type, null ); }
   92           
   93           /** Parses a {@link XmlIDREFS} fragment from a File. */
   94           public static XmlIDREFS parse(java.io.File f, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, java.io.IOException {
   95             return (XmlIDREFS) XmlBeans.getContextTypeLoader().parse( f, type, options ); }
   96           
   97           /** Parses a {@link XmlIDREFS} fragment from a URL. */
   98           public static XmlIDREFS parse(java.net.URL u) throws org.apache.xmlbeans.XmlException, java.io.IOException {
   99             return (XmlIDREFS) XmlBeans.getContextTypeLoader().parse( u, type, null ); }
  100   
  101           /** Parses a {@link XmlIDREFS} fragment from a URL. */
  102           public static XmlIDREFS parse(java.net.URL u, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, java.io.IOException {
  103             return (XmlIDREFS) XmlBeans.getContextTypeLoader().parse( u, type, options ); }
  104   
  105           /** Parses a {@link XmlIDREFS} fragment from an InputStream. */
  106           public static XmlIDREFS parse(java.io.InputStream is) throws org.apache.xmlbeans.XmlException, java.io.IOException {
  107             return (XmlIDREFS) XmlBeans.getContextTypeLoader().parse( is, type, null ); }
  108           
  109           /** Parses a {@link XmlIDREFS} fragment from an InputStream. */
  110           public static XmlIDREFS parse(java.io.InputStream is, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, java.io.IOException {
  111             return (XmlIDREFS) XmlBeans.getContextTypeLoader().parse( is, type, options ); }
  112           
  113           /** Parses a {@link XmlIDREFS} fragment from a Reader. */
  114           public static XmlIDREFS parse(java.io.Reader r) throws org.apache.xmlbeans.XmlException, java.io.IOException {
  115             return (XmlIDREFS) XmlBeans.getContextTypeLoader().parse( r, type, null ); }
  116           
  117           /** Parses a {@link XmlIDREFS} fragment from a Reader. */
  118           public static XmlIDREFS parse(java.io.Reader r, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, java.io.IOException {
  119             return (XmlIDREFS) XmlBeans.getContextTypeLoader().parse( r, type, options ); }
  120           
  121           /** Parses a {@link XmlIDREFS} fragment from a DOM Node. */
  122           public static XmlIDREFS parse(org.w3c.dom.Node node) throws org.apache.xmlbeans.XmlException {
  123             return (XmlIDREFS) XmlBeans.getContextTypeLoader().parse( node, type, null ); }
  124           
  125           /** Parses a {@link XmlIDREFS} fragment from a DOM Node. */
  126           public static XmlIDREFS parse(org.w3c.dom.Node node, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException {
  127             return (XmlIDREFS) XmlBeans.getContextTypeLoader().parse( node, type, options ); }
  128           
  129           /** Parses a {@link XmlIDREFS} fragment from an XMLInputStream.
  130            * @deprecated XMLInputStream was deprecated by XMLStreamReader from STaX - jsr173 API.
  131            */
  132           public static XmlIDREFS parse(org.apache.xmlbeans.xml.stream.XMLInputStream xis) throws org.apache.xmlbeans.XmlException, org.apache.xmlbeans.xml.stream.XMLStreamException {
  133             return (XmlIDREFS) XmlBeans.getContextTypeLoader().parse( xis, type, null ); }
  134           
  135           /** Parses a {@link XmlIDREFS} fragment from an XMLInputStream.
  136            * @deprecated XMLInputStream was deprecated by XMLStreamReader from STaX - jsr173 API.
  137            */
  138           public static XmlIDREFS parse(org.apache.xmlbeans.xml.stream.XMLInputStream xis, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, org.apache.xmlbeans.xml.stream.XMLStreamException {
  139             return (XmlIDREFS) XmlBeans.getContextTypeLoader().parse( xis, type, options ); }
  140           
  141           /** Parses a {@link XmlIDREFS} fragment from an XMLStreamReader. */
  142           public static XmlIDREFS parse(javax.xml.stream.XMLStreamReader xsr) throws org.apache.xmlbeans.XmlException {
  143             return (XmlIDREFS) XmlBeans.getContextTypeLoader().parse( xsr, type, null ); }
  144           
  145           /** Parses a {@link XmlIDREFS} fragment from an XMLStreamReader. */
  146           public static XmlIDREFS parse(javax.xml.stream.XMLStreamReader xsr, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException{
  147             return (XmlIDREFS) XmlBeans.getContextTypeLoader().parse( xsr, type, options ); }
  148           
  149           /** Returns a validating XMLInputStream.
  150            * @deprecated XMLInputStream was deprecated by XMLStreamReader from STaX - jsr173 API.
  151            */
  152           public static org.apache.xmlbeans.xml.stream.XMLInputStream newValidatingXMLInputStream(org.apache.xmlbeans.xml.stream.XMLInputStream xis) throws org.apache.xmlbeans.XmlException, org.apache.xmlbeans.xml.stream.XMLStreamException {
  153             return XmlBeans.getContextTypeLoader().newValidatingXMLInputStream( xis, type, null ); }
  154           
  155           /** Returns a validating XMLInputStream.
  156            * @deprecated XMLInputStream was deprecated by XMLStreamReader from STaX - jsr173 API.
  157            */
  158           public static org.apache.xmlbeans.xml.stream.XMLInputStream newValidatingXMLInputStream(org.apache.xmlbeans.xml.stream.XMLInputStream xis, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, org.apache.xmlbeans.xml.stream.XMLStreamException {
  159             return XmlBeans.getContextTypeLoader().newValidatingXMLInputStream( xis, type, options ); }
  160           
  161           private Factory() { } // No instance of this class allowed
  162       }
  163   }
  164   

Home » xmlbeans-2.5.0-src » org.apache » xmlbeans » [javadoc | source]