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

javax.xml.parsers.DocumentBuilderFactory Maven / Gradle / Ivy

There is a newer version: 2.6.2
Show newest version
/*
 * The Apache Software License, Version 1.1
 *
 *
 * Copyright (c) 2001 The Apache Software Foundation.  All rights 
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer. 
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:  
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The name "Apache Software Foundation" must not be used to endorse or
 *    promote products derived from this software without prior written
 *    permission. For written permission, please contact [email protected].
 *
 * 5. Products derived from this software may not be called "Apache",
 *    nor may "Apache" appear in their name, without prior written
 *    permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation and was
 * originally based on software copyright (c) 1999-2001, Sun Microsystems,
 * Inc., http://www.sun.com.  For more information on the Apache Software
 * Foundation, please see .
 */

package javax.xml.parsers;

import java.io.InputStream;
import java.io.IOException;
import java.io.File;
import java.io.FileInputStream;

import java.util.Properties;
import java.io.BufferedReader;
import java.io.InputStreamReader;

/**
 * Defines a factory API that enables applications to obtain a
 * parser that produces DOM object trees from XML documents.
 *
 * An implementation of the DocumentBuilderFactory class is
 * NOT guaranteed to be thread safe. It is up to the user application 
 * to make sure about the use of the DocumentBuilderFactory from 
 * more than one thread. Alternatively the application can have one instance 
 * of the DocumentBuilderFactory per thread.
 * An application can use the same instance of the factory to obtain one or 
 * more instances of the DocumentBuilder provided the instance
 * of the factory isn't being used in more than one thread at a time.
 *
 * @since JAXP 1.0
 * @version 1.0
 */

public abstract class DocumentBuilderFactory {
    private boolean validating = false;
    private boolean namespaceAware = false;
    private boolean whitespace = false;
    private boolean expandEntityRef = true;
    private boolean ignoreComments = false;
    private boolean coalescing = false;
    
    protected DocumentBuilderFactory () {
    
    }

    /**
     * Obtain a new instance of a
     * DocumentBuilderFactory. This static method creates
     * a new factory instance.
     * This method uses the following ordered lookup procedure to determine
     * the DocumentBuilderFactory implementation class to
     * load:
     * 
    *
  • * Use the javax.xml.parsers.DocumentBuilderFactory system * property. *
  • *
  • * Use the properties file "lib/jaxp.properties" in the JRE directory. * This configuration file is in standard java.util.Properties * format and contains the fully qualified name of the * implementation class with the key being the system property defined * above. *
  • *
  • * Use the Services API (as detailed in the JAR specification), if * available, to determine the classname. The Services API will look * for a classname in the file * META-INF/services/javax.xml.parsers.DocumentBuilderFactory * in jars available to the runtime. *
  • *
  • * Platform default DocumentBuilderFactory instance. *
  • *
* * Once an application has obtained a reference to a * DocumentBuilderFactory it can use the factory to * configure and obtain parser instances. * * @exception FactoryConfigurationError if the implementation is not * available or cannot be instantiated. */ public static DocumentBuilderFactory newInstance() throws FactoryConfigurationError { try { return (DocumentBuilderFactory) FactoryFinder.find( /* The default property name according to the JAXP spec */ "javax.xml.parsers.DocumentBuilderFactory", /* The fallback implementation class name */ "org.apache.xerces.jaxp.DocumentBuilderFactoryImpl"); } catch (FactoryFinder.ConfigurationError e) { throw new FactoryConfigurationError(e.getException(), e.getMessage()); } } /** * Creates a new instance of a {@link javax.xml.parsers.DocumentBuilder} * using the currently configured parameters. * * @exception ParserConfigurationException if a DocumentBuilder * cannot be created which satisfies the configuration requested. * @return A new instance of a DocumentBuilder. */ public abstract DocumentBuilder newDocumentBuilder() throws ParserConfigurationException; /** * Specifies that the parser produced by this code will * provide support for XML namespaces. By default the value of this is set * to false * * @param awareness true if the parser produced will provide support * for XML namespaces; false otherwise. */ public void setNamespaceAware(boolean awareness) { this.namespaceAware = awareness; } /** * Specifies that the parser produced by this code will * validate documents as they are parsed. By default the value of this * is set to false. * * @param validating true if the parser produced will validate documents * as they are parsed; false otherwise. */ public void setValidating(boolean validating) { this.validating = validating; } /** * Specifies that the parsers created by this factory must eliminate * whitespace in element content (sometimes known loosely as * 'ignorable whitespace') when parsing XML documents (see XML Rec * 2.10). Note that only whitespace which is directly contained within * element content that has an element only content model (see XML * Rec 3.2.1) will be eliminated. Due to reliance on the content model * this setting requires the parser to be in validating mode. By default * the value of this is set to false. * * @param whitespace true if the parser created must eliminate whitespace * in the element content when parsing XML documents; * false otherwise. */ public void setIgnoringElementContentWhitespace(boolean whitespace) { this.whitespace = whitespace; } /** * Specifies that the parser produced by this code will * expand entity reference nodes. By default the value of this is set to * true * * @param expandEntityRef true if the parser produced will expand entity * reference nodes; false otherwise. */ public void setExpandEntityReferences(boolean expandEntityRef) { this.expandEntityRef = expandEntityRef; } /** * Specifies that the parser produced by this code will * ignore comments. By default the value of this is set to false * */ public void setIgnoringComments(boolean ignoreComments) { this.ignoreComments = ignoreComments; } /** * Specifies that the parser produced by this code will * convert CDATA nodes to Text nodes and append it to the * adjacent (if any) text node. By default the value of this is set to * false * * @param coalescing true if the parser produced will convert CDATA nodes * to Text nodes and append it to the adjacent (if any) * text node; false otherwise. */ public void setCoalescing(boolean coalescing) { this.coalescing = coalescing; } /** * Indicates whether or not the factory is configured to produce * parsers which are namespace aware. * * @return true if the factory is configured to produce parsers which * are namespace aware; false otherwise. */ public boolean isNamespaceAware() { return namespaceAware; } /** * Indicates whether or not the factory is configured to produce * parsers which validate the XML content during parse. * * @return true if the factory is configured to produce parsers * which validate the XML content during parse; false otherwise. */ public boolean isValidating() { return validating; } /** * Indicates whether or not the factory is configured to produce * parsers which ignore ignorable whitespace in element content. * * @return true if the factory is configured to produce parsers * which ignore ignorable whitespace in element content; * false otherwise. */ public boolean isIgnoringElementContentWhitespace() { return whitespace; } /** * Indicates whether or not the factory is configured to produce * parsers which expand entity reference nodes. * * @return true if the factory is configured to produce parsers * which expand entity reference nodes; false otherwise. */ public boolean isExpandEntityReferences() { return expandEntityRef; } /** * Indicates whether or not the factory is configured to produce * parsers which ignores comments. * * @return true if the factory is configured to produce parsers * which ignores comments; false otherwise. */ public boolean isIgnoringComments() { return ignoreComments; } /** * Indicates whether or not the factory is configured to produce * parsers which converts CDATA nodes to Text nodes and appends it to * the adjacent (if any) Text node. * * @return true if the factory is configured to produce parsers * which converts CDATA nodes to Text nodes and appends it to * the adjacent (if any) Text node; false otherwise. */ public boolean isCoalescing() { return coalescing; } /** * Allows the user to set specific attributes on the underlying * implementation. * @param name The name of the attribute. * @param value The value of the attribute. * @exception IllegalArgumentException thrown if the underlying * implementation doesn't recognize the attribute. */ public abstract void setAttribute(String name, Object value) throws IllegalArgumentException; /** * Allows the user to retrieve specific attributes on the underlying * implementation. * @param name The name of the attribute. * @return value The value of the attribute. * @exception IllegalArgumentException thrown if the underlying * implementation doesn't recognize the attribute. */ public abstract Object getAttribute(String name) throws IllegalArgumentException; }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy