javax.xml.XMLConstants Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ocap Show documentation
The newest version!
/*
 * Portions Copyright  2000-2008 Sun Microsystems, Inc. All Rights
 * Reserved.  Use is subject to license terms.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License version
 * 2 only, as published by the Free Software Foundation.
 * 
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License version 2 for more details (a copy is
 * included at /legal/license.txt).
 * 
 * You should have received a copy of the GNU General Public License
 * version 2 along with this work; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 * 
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
 * Clara, CA 95054 or visit www.sun.com if you need additional
 * information or have any questions.
 */

package javax.xml;

/**
 * Utility class to contain basic XML values as constants.
 * 
 * @author JAXP Java Community Process
 * @author JAXP Reference Implementation
 * @version 1.0.proposed
 * @see  Extensible Markup Language (XML)
 *      1.0 (Second Edition)
 * @see  Namespaces in XML
 * @see  Namespaces in
 *      XML Errata
 */

public class XMLConstants {

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

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

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

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

    /**
     * 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
     */
    public static final String XMLNS_ATTRIBUTE = "xmlns";

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

    /**
     * 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 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";

}