org.apache.xmlbeans.XmlName 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;
/**
* Corresponds to the XML Schema
* xs:Name type.
* One of the derived types based on xs:string.
*
* This kind of string is the same as the lexical representation used for XML 1.0
* element and attribute names, e.g., "pre:a-b.cdef". It is just a physical
* string, however, and it should NOT be confused with {@link XmlQName},
* which is a logical combination of localname and namespace URI.
*
* Convertible to {@link String}.
*/
public interface XmlName extends XmlToken {
/**
* The constant {@link SchemaType} object representing this schema type.
*/
SchemaType type = XmlBeans.getBuiltinTypeSystem().typeForHandle("_BI_Name");
/**
* A class with methods for creating instances
* of {@link XmlName}.
*/
final class Factory {
/**
* Creates an empty instance of {@link XmlName}
*/
public static XmlName newInstance() {
return (XmlName) XmlBeans.getContextTypeLoader().newInstance(type, null);
}
/**
* Creates an empty instance of {@link XmlName}
*/
public static XmlName newInstance(org.apache.xmlbeans.XmlOptions options) {
return (XmlName) XmlBeans.getContextTypeLoader().newInstance(type, options);
}
/**
* Creates an immutable {@link XmlName} value
*/
public static XmlName newValue(Object obj) {
return (XmlName) type.newValue(obj);
}
/**
* Parses a {@link XmlName} fragment from a String. For example: "<xml-fragment>My:Name</xml-fragment>".
*/
public static XmlName parse(java.lang.String s) throws org.apache.xmlbeans.XmlException {
return (XmlName) XmlBeans.getContextTypeLoader().parse(s, type, null);
}
/**
* Parses a {@link XmlName} fragment from a String. For example: "<xml-fragment>My:Name</xml-fragment>".
*/
public static XmlName parse(java.lang.String s, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException {
return (XmlName) XmlBeans.getContextTypeLoader().parse(s, type, options);
}
/**
* Parses a {@link XmlName} fragment from a File.
*/
public static XmlName parse(java.io.File f) throws org.apache.xmlbeans.XmlException, java.io.IOException {
return (XmlName) XmlBeans.getContextTypeLoader().parse(f, type, null);
}
/**
* Parses a {@link XmlName} fragment from a File.
*/
public static XmlName parse(java.io.File f, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, java.io.IOException {
return (XmlName) XmlBeans.getContextTypeLoader().parse(f, type, options);
}
/**
* Parses a {@link XmlName} fragment from a URL.
*/
public static XmlName parse(java.net.URL u) throws org.apache.xmlbeans.XmlException, java.io.IOException {
return (XmlName) XmlBeans.getContextTypeLoader().parse(u, type, null);
}
/**
* Parses a {@link XmlName} fragment from a URL.
*/
public static XmlName parse(java.net.URL u, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, java.io.IOException {
return (XmlName) XmlBeans.getContextTypeLoader().parse(u, type, options);
}
/**
* Parses a {@link XmlName} fragment from an InputStream.
*/
public static XmlName parse(java.io.InputStream is) throws org.apache.xmlbeans.XmlException, java.io.IOException {
return (XmlName) XmlBeans.getContextTypeLoader().parse(is, type, null);
}
/**
* Parses a {@link XmlName} fragment from an InputStream.
*/
public static XmlName parse(java.io.InputStream is, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, java.io.IOException {
return (XmlName) XmlBeans.getContextTypeLoader().parse(is, type, options);
}
/**
* Parses a {@link XmlName} fragment from a Reader.
*/
public static XmlName parse(java.io.Reader r) throws org.apache.xmlbeans.XmlException, java.io.IOException {
return (XmlName) XmlBeans.getContextTypeLoader().parse(r, type, null);
}
/**
* Parses a {@link XmlName} fragment from a Reader.
*/
public static XmlName parse(java.io.Reader r, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException, java.io.IOException {
return (XmlName) XmlBeans.getContextTypeLoader().parse(r, type, options);
}
/**
* Parses a {@link XmlName} fragment from a DOM Node.
*/
public static XmlName parse(org.w3c.dom.Node node) throws org.apache.xmlbeans.XmlException {
return (XmlName) XmlBeans.getContextTypeLoader().parse(node, type, null);
}
/**
* Parses a {@link XmlName} fragment from a DOM Node.
*/
public static XmlName parse(org.w3c.dom.Node node, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException {
return (XmlName) XmlBeans.getContextTypeLoader().parse(node, type, options);
}
/**
* Parses a {@link XmlName} fragment from an XMLStreamReader.
*/
public static XmlName parse(javax.xml.stream.XMLStreamReader xsr) throws org.apache.xmlbeans.XmlException {
return (XmlName) XmlBeans.getContextTypeLoader().parse(xsr, type, null);
}
/**
* Parses a {@link XmlName} fragment from an XMLStreamReader.
*/
public static XmlName parse(javax.xml.stream.XMLStreamReader xsr, org.apache.xmlbeans.XmlOptions options) throws org.apache.xmlbeans.XmlException {
return (XmlName) XmlBeans.getContextTypeLoader().parse(xsr, type, options);
}
private Factory() {
// No instance of this class allowed
}
}
}