javax.xml.XMLConstants Maven / Gradle / Ivy

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */

// $Id: XMLConstants.java 584477 2007-10-14 02:44:03Z mrglavas $

package javax.xml;

/**
 * Utility class to contain basic XML values as constants.
 *
 * @author Jeff Suttor
 * @version $Revision: 584477 $, $Date: 2007-10-13 19:44:03 -0700 (Sat, 13 Oct 2007) $
 * @see Extensible Markup Language (XML) 1.1
 * @see Extensible Markup Language (XML) 1.0 (Second Edition)
 * @see XML 1.0 Second Edition Specification Errata
 * @see Namespaces in XML 1.1
 * @see Namespaces in XML
 * @see Namespaces in XML Errata
 * @see XML Schema Part 1: Structures
 * @since 1.5
 **/
public final class XMLConstants {

    /**
     * Private constructor to prevent instantiation.
     */
    private XMLConstants() {
    }

    /**
     * Namespace URI to use to represent that there is no Namespace.
     *
     * Defined by the Namespace specification to be "".
     *
     * @see 
     * Namespaces in XML, 5.2 Namespace Defaulting
     */
    public static final String NULL_NS_URI = "";

    /**
     * Prefix to use to represent the default XML Namespace.
     *
     * Defined by the XML specification to be "".
     *
     * @see 
     * Namespaces in XML, 3. Qualified Names
     */
    public static final String DEFAULT_NS_PREFIX = "";

    /**
     * The official XML Namespace name URI.
     *
     * Defined by the XML specification to be
     * "http://www.w3.org/XML/1998/namespace".
     *
     * @see 
     * Namespaces in XML, 3. Qualified Names
     */
    public static final String XML_NS_URI =
        "http://www.w3.org/XML/1998/namespace";

    /**
     * The official XML Namespace prefix.
     *
     * Defined by the XML specification to be "xml".
     *
     * @see 
     * Namespaces in XML, 3. Qualified Names
     */
    public static final String XML_NS_PREFIX = "xml";

    /**
     * The official XML attribute used for specifying XML Namespace
     * declarations, {@link #XMLNS_ATTRIBUTE
     * XMLConstants.XMLNS_ATTRIBUTE}, Namespace name URI.
     *
     * Defined by the XML specification to be
     * "http://www.w3.org/2000/xmlns/".
     *
     * @see 
     * Namespaces in XML, 3. Qualified Names
     * @see 
     * Namespaces in XML Errata
     */
    public static final String XMLNS_ATTRIBUTE_NS_URI =
        "http://www.w3.org/2000/xmlns/";

    /**
     * The official XML attribute used for specifying XML Namespace
     * declarations.
     *
     * It is NOT valid to use as a
     * prefix.  Defined by the XML specification to be
     * "xmlns".
     *
     * @see 
     * Namespaces in XML, 3. Qualified Names
     */
    public static final String XMLNS_ATTRIBUTE = "xmlns";

    /**
     * W3C XML Schema Namespace URI.
     *
     * Defined to be "http://www.w3.org/2001/XMLSchema".
     *
     * @see 
     *  XML Schema Part 1:
     *  Structures, 2.6 Schema-Related Markup in Documents Being Validated
     */
    public static final String W3C_XML_SCHEMA_NS_URI =
        "http://www.w3.org/2001/XMLSchema";

    /**
     * 
W3C XML Schema Instance Namespace URI.
     *
     * Defined to be "http://www.w3.org/2001/XMLSchema-instance".
     *
     * @see 
     *  XML Schema Part 1:
     *  Structures, 2.6 Schema-Related Markup in Documents Being Validated
     */
    public static final String W3C_XML_SCHEMA_INSTANCE_NS_URI =
        "http://www.w3.org/2001/XMLSchema-instance";

    /**
     * W3C XPath Datatype Namespace URI.
     *
     * Defined to be "http://www.w3.org/2003/11/xpath-datatypes".
     *
     * @see XQuery 1.0 and XPath 2.0 Data Model
     */
    public static final String W3C_XPATH_DATATYPE_NS_URI = "http://www.w3.org/2003/11/xpath-datatypes";

    /**
     * XML Document Type Declaration Namespace URI as an arbitrary value.
     *
     * Since not formally defined by any existing standard, arbitrarily define to be "http://www.w3.org/TR/REC-xml".
     */
    public static final String XML_DTD_NS_URI = "http://www.w3.org/TR/REC-xml";

    /**
     * 
RELAX NG Namespace URI.
     *
     * Defined to be "http://relaxng.org/ns/structure/1.0".
     *
     * @see RELAX NG Specification
     */
    public static final String RELAXNG_NS_URI = "http://relaxng.org/ns/structure/1.0";

    /**
     * Feature for secure processing.
     *
     * 
     *   
     *     true instructs the implementation to process XML securely.
     *     This may set limits on XML constructs to avoid conditions such as denial of service attacks.
     *   
     *   
     *     false instructs the implementation to process XML according to the letter of the XML specifications
     *     ignoring security issues such as limits on XML constructs to avoid conditions such as denial of service attacks.
     *   
     * 
     */
    public static final String FEATURE_SECURE_PROCESSING = "http://javax.xml.XMLConstants/feature/secure-processing";
}