All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.xmlbeans.XmlID Maven / Gradle / Ivy

Go to download

The Apache Commons Codec package contains simple encoder and decoders for various formats such as Base64 and Hexadecimal. In addition to these widely used encoders and decoders, the codec package also maintains a collection of phonetic encoding utilities.

The newest version!
/*   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;

import javax.xml.stream.XMLStreamReader;


/**
 * Corresponds to the XML Schema
 * xs:ID type.
 * 

* When validated, IDs must be unique within a document. An element * may not have more than one attribute whose type is ID. *

* Convertible to a {@link String}. */ public interface XmlID extends XmlNCName { /** The constant {@link SchemaType} object representing this schema type. */ public static final SchemaType type = XmlBeans.getBuiltinTypeSystem().typeForHandle("_BI_ID"); /** * A class with methods for creating instances * of {@link XmlID}. */ public static final class Factory { /** Creates an empty instance of {@link XmlID} */ public static XmlID newInstance() { return (XmlID) XmlBeans.getContextTypeLoader().newInstance( type, null ); } /** Creates an empty instance of {@link XmlID} */ public static XmlID newInstance(org.apache.xmlbeans.XmlOptions options) { return (XmlID) XmlBeans.getContextTypeLoader().newInstance( type, options ); } /** Creates an immutable {@link XmlID} value */ public static XmlID newValue(Object obj) { return (XmlID) type.newValue( obj ); } /** Parses a {@link XmlID} fragment from a String. For example: "<xml-fragment>n1</xml-fragment>". */ public static XmlID parse(java.lang.String s) throws org.apache.xmlbeans.XmlException { return (XmlID) XmlBeans.getContextTypeLoader().parse( s, type, null ); } /** Parses a {@link XmlID} fragment from a String. For example: "<xml-fragment>n1</xml-fragment>". */ public static XmlID parse(java.lang.String s, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException { return (XmlID) XmlBeans.getContextTypeLoader().parse( s, type, options ); } /** Parses a {@link XmlID} fragment from a File. */ public static XmlID parse(java.io.File f) throws org.apache.xmlbeans.XmlException, java.io.IOException { return (XmlID) XmlBeans.getContextTypeLoader().parse( f, type, null ); } /** Parses a {@link XmlID} fragment from a File. */ public static XmlID parse(java.io.File f, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, java.io.IOException { return (XmlID) XmlBeans.getContextTypeLoader().parse( f, type, options ); } /** Parses a {@link XmlID} fragment from a URL. */ public static XmlID parse(java.net.URL u) throws org.apache.xmlbeans.XmlException, java.io.IOException { return (XmlID) XmlBeans.getContextTypeLoader().parse( u, type, null ); } /** Parses a {@link XmlID} fragment from a URL. */ public static XmlID parse(java.net.URL u, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, java.io.IOException { return (XmlID) XmlBeans.getContextTypeLoader().parse( u, type, options ); } /** Parses a {@link XmlID} fragment from an InputStream. */ public static XmlID parse(java.io.InputStream is) throws org.apache.xmlbeans.XmlException, java.io.IOException { return (XmlID) XmlBeans.getContextTypeLoader().parse( is, type, null ); } /** Parses a {@link XmlID} fragment from an InputStream. */ public static XmlID parse(java.io.InputStream is, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, java.io.IOException { return (XmlID) XmlBeans.getContextTypeLoader().parse( is, type, options ); } /** Parses a {@link XmlID} fragment from a Reader. */ public static XmlID parse(java.io.Reader r) throws org.apache.xmlbeans.XmlException, java.io.IOException { return (XmlID) XmlBeans.getContextTypeLoader().parse( r, type, null ); } /** Parses a {@link XmlID} fragment from a Reader. */ public static XmlID parse(java.io.Reader r, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, java.io.IOException { return (XmlID) XmlBeans.getContextTypeLoader().parse( r, type, options ); } /** Parses a {@link XmlID} fragment from a DOM Node. */ public static XmlID parse(org.w3c.dom.Node node) throws org.apache.xmlbeans.XmlException { return (XmlID) XmlBeans.getContextTypeLoader().parse( node, type, null ); } /** Parses a {@link XmlID} fragment from a DOM Node. */ public static XmlID parse(org.w3c.dom.Node node, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException { return (XmlID) XmlBeans.getContextTypeLoader().parse( node, type, options ); } /** Parses a {@link XmlID} fragment from an XMLInputStream. * @deprecated XMLInputStream was deprecated by XMLStreamReader from STaX - jsr173 API. */ public static XmlID parse(org.apache.xmlbeans.xml.stream.XMLInputStream xis) throws org.apache.xmlbeans.XmlException, org.apache.xmlbeans.xml.stream.XMLStreamException { return (XmlID) XmlBeans.getContextTypeLoader().parse( xis, type, null ); } /** Parses a {@link XmlID} fragment from an XMLInputStream. * @deprecated XMLInputStream was deprecated by XMLStreamReader from STaX - jsr173 API. */ public static XmlID parse(org.apache.xmlbeans.xml.stream.XMLInputStream xis, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, org.apache.xmlbeans.xml.stream.XMLStreamException { return (XmlID) XmlBeans.getContextTypeLoader().parse( xis, type, options ); } /** Parses a {@link XmlID} fragment from an XMLStreamReader. */ public static XmlID parse(javax.xml.stream.XMLStreamReader xsr) throws org.apache.xmlbeans.XmlException { return (XmlID) XmlBeans.getContextTypeLoader().parse( xsr, type, null ); } /** Parses a {@link XmlID} fragment from an XMLStreamReader. */ public static XmlID parse(javax.xml.stream.XMLStreamReader xsr, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException{ return (XmlID) XmlBeans.getContextTypeLoader().parse( xsr, type, options ); } /** Returns a validating XMLInputStream. * @deprecated XMLInputStream was deprecated by XMLStreamReader from STaX - jsr173 API. */ 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 { return XmlBeans.getContextTypeLoader().newValidatingXMLInputStream( xis, type, null ); } /** Returns a validating XMLInputStream. * @deprecated XMLInputStream was deprecated by XMLStreamReader from STaX - jsr173 API. */ 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 { return XmlBeans.getContextTypeLoader().newValidatingXMLInputStream( xis, type, options ); } private Factory() { } // No instance of this class allowed } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy