summaryrefslogtreecommitdiff
path: root/external/jaxp/source/javax/xml/parsers/SAXParserFactory.java
blob: 760c737fa543fe7b520b3812f978f12a3410ad34 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
/*
 * $Id: SAXParserFactory.java,v 1.1 2003-02-01 02:10:27 cbj Exp $
 * Copyright (C) 2001 Andrew Selkirk
 * Copyright (C) 2001 David Brownell
 * 
 * This file is part of GNU JAXP, a library.
 *
 * GNU JAXP is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * GNU JAXP 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 for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * As a special exception, if you link this library with other files to
 * produce an executable, this library does not by itself cause the
 * resulting executable to be covered by the GNU General Public License.
 * This exception does not however invalidate any other reasons why the
 * executable file might be covered by the GNU General Public License. 
 */

package javax.xml.parsers;

// Imports
import java.io.IOException;
import java.io.InputStream;
import java.io.File;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.util.Properties;
import org.w3c.dom.*;
import org.xml.sax.*;

/**
 * SAXParserFactory is used to bootstrap JAXP wrappers for
 * SAX parsers.
 *
 * <para> Note that the JAXP 1.1 spec does not specify how
 * the <em>isValidating()</em> or <em>isNamespaceAware()</em>
 * flags relate to the SAX2 feature flags controlling those
 * same features.
 *
 * @author	Andrew Selkirk, David Brownell
 * @version	1.0
 */

public abstract class SAXParserFactory {

	//-------------------------------------------------------------
	// Variables --------------------------------------------------
	//-------------------------------------------------------------

	private static final	String defaultPropName	=
		"javax.xml.parsers.SAXParserFactory";

	private 		boolean validating	= false;
	private 		boolean namespaceAware	= false;


	//-------------------------------------------------------------
	// Initialization ---------------------------------------------
	//-------------------------------------------------------------

	protected SAXParserFactory() {
	} // SAXParserFactory()


	//-------------------------------------------------------------
	// Methods ----------------------------------------------------
	//-------------------------------------------------------------

	public static SAXParserFactory newInstance() {
		try {
		    return (SAXParserFactory)
			ClassStuff.createFactory (
				defaultPropName, 
				"gnu.xml.aelfred2.JAXPFactory");
		} catch (ClassCastException e) {
			throw new FactoryConfigurationError (e,
				"Factory class is the wrong type");
		}
	}

	/**
	 * Returns a new instance of a SAXParser using the platform
	 * default implementation and the currently specified factory
	 * feature flag settings.
	 *
	 * @exception ParserConfigurationException
	 *	when the parameter combination is not supported
	 * @exception SAXNotRecognizedException
	 *	if one of the specified SAX2 feature flags is not recognized
	 * @exception SAXNotSupportedException
	 *	if one of the specified SAX2 feature flags values can
	 *	not be set, perhaps because of sequencing requirements
	 *	(which could be met by using SAX2 directly)
	 */
	public abstract SAXParser newSAXParser()
		throws ParserConfigurationException, SAXException;

	public void setNamespaceAware(boolean value) {
		namespaceAware = value;
	} // setNamespaceAware()

	public void setValidating(boolean value) {
		validating = value;
	} // setValidating()
	
	public boolean isNamespaceAware() {
		return namespaceAware;
	} // isNamespaceAware()

	public boolean isValidating() {
		return validating;
	} // isValidating()

	/**
	 * Establishes a factory parameter corresponding to the
	 * specified feature flag.
	 *
	 * @param name identifies the feature flag
	 * @param value specifies the desired flag value
	 *
	 * @exception SAXNotRecognizedException
	 *	if the specified SAX2 feature flag is not recognized
	 * @exception SAXNotSupportedException
	 *	if the specified SAX2 feature flag values can not be set,
	 *	perhaps because of sequencing requirements (which could
	 *	be met by using SAX2 directly)
	 */
	public abstract void setFeature (String name, boolean value) 
		throws	ParserConfigurationException, 
			SAXNotRecognizedException, 
			SAXNotSupportedException;

	/**
	 * Retrieves a current factory feature flag setting.
	 *
	 * @param name identifies the feature flag
	 *
	 * @exception SAXNotRecognizedException
	 *	if the specified SAX2 feature flag is not recognized
	 * @exception SAXNotSupportedException
	 *	if the specified SAX2 feature flag values can not be
	 *	accessed before parsing begins.
	 */
	public abstract boolean getFeature (String name) 
		throws	ParserConfigurationException, 
			SAXNotRecognizedException, 
			SAXNotSupportedException;

} // SAXParserFactory