- java.lang.Object
-
- javax.xml.parsers.SAXParserFactory
-
public abstract class SAXParserFactoryextends Object
定义工厂API,使应用程序能够配置和获取基于SAX的解析器来解析XML文档。- 从以下版本开始:
- 1.4
-
-
构造方法摘要
构造方法 变量 构造器 描述 protected
SAXParserFactory()
受保护的构造函数强制使用newInstance()
。
-
方法摘要
所有方法 静态方法 实例方法 抽象方法 具体的方法 变量和类型 方法 描述 abstract boolean
getFeature(String name)
返回org.xml.sax.XMLReader的底层实现中请求的特定属性。Schema
getSchema()
获取通过setSchema(Schema schema)
方法指定的Schema
对象。boolean
isNamespaceAware()
指示工厂是否配置为生成可识别名称空间的解析器。boolean
isValidating()
指示工厂是否配置为生成在解析期间验证XML内容的解析器。boolean
isXIncludeAware()
获取XInclude处理的状态。static SAXParserFactory
newDefaultInstance()
创建SAXParserFactory
内置系统默认实现的新实例。static SAXParserFactory
newInstance()
获取SAXParserFactory
的新实例。static SAXParserFactory
newInstance(String factoryClassName, ClassLoader classLoader)
从类名获取SAXParserFactory
的新实例。abstract SAXParser
newSAXParser()
使用当前配置的工厂参数创建SAXParser的新实例。abstract void
setFeature(String name, boolean value)
设置org.xml.sax.XMLReader的底层实现中的特定功能。void
setNamespaceAware(boolean awareness)
指定此代码生成的解析器将提供对XML命名空间的支持。void
setSchema(Schema schema)
设置要从此工厂创建的解析器使用的Schema
。void
setValidating(boolean validating)
指定此代码生成的解析器将在解析文档时验证它们。void
setXIncludeAware(boolean state)
设置XInclude处理的状态。
-
-
-
构造方法详细信息
-
SAXParserFactory
protected SAXParserFactory()
受保护的构造函数强制使用newInstance()
。
-
-
方法详细信息
-
newDefaultInstance
public static SAXParserFactory newDefaultInstance()
创建SAXParserFactory
内置系统默认实现的新实例。- 结果
-
SAXParserFactory
内置系统默认实现的新实例。 - 从以下版本开始:
- 9
-
newInstance
public static SAXParserFactory newInstance()
获取SAXParserFactory
的新实例。 此静态方法创建新的工厂实例此方法使用以下有序查找过程来确定要加载的SAXParserFactory
实现类:- 使用
javax.xml.parsers.SAXParserFactory
系统属性。 使用配置文件“jaxp.properties”。 该文件采用标准
Properties
格式,通常位于Java安装的conf
目录中。 它包含实现类的完全限定名称,键是上面定义的系统属性。jaxp.properties文件只能由JAXP实现读取一次,然后缓存其值以供将来使用。 如果在第一次尝试从该文件读取时该文件不存在,则不再进行任何检查以检查其是否存在。 在第一次读取之后,无法更改jaxp.properties中任何属性的值。
使用由
ServiceLoader
类定义的服务提供者加载工具尝试使用default loading mechanism查找和加载服务的实现 :服务提供者加载工具将使用current thread's context class loader尝试加载服务。 如果上下文类加载器为null,则将使用system class loader 。否则,返回system-default实现。
一旦应用程序获得对
SAXParserFactory
的引用,它就可以使用工厂来配置和获取解析器实例。故障排除提示
设置
jaxp.debug
系统属性将导致此方法将大量调试消息打印到System.err
了解它正在做什么以及它在哪里查看。如果您在加载
SAXParser
时遇到问题,请尝试:java -Djaxp.debug=1 YourProgram ....
- 结果
- SAXParserFactory的新实例。
- 异常
-
FactoryConfigurationError
- 如果是service configuration error,或者实现不可用或无法实例化。
- 使用
-
newInstance
public static SAXParserFactory newInstance(String factoryClassName, ClassLoader classLoader)
从类名获取SAXParserFactory
的新实例。 当类路径中有多个提供程序时,此函数很有用。 它为应用程序提供了更多控制,因为它可以指定应该加载哪个提供程序。一旦应用程序获得对
SAXParserFactory
的引用,它就可以使用工厂来配置和获取解析器实例。故障排除提示
设置
jaxp.debug
系统属性将导致此方法将大量调试消息打印到System.err
了解它正在做什么以及它在哪里查看。如果您遇到问题,请尝试:
java -Djaxp.debug=1 YourProgram ....
- 参数
-
factoryClassName
- 提供javax.xml.parsers.SAXParserFactory
实现的完全限定工厂类名称。 -
classLoader
-ClassLoader
用于加载工厂类。 如果null
当前Thread
的上下文classLoader用于加载工厂类。 - 结果
- 新实例
SAXParserFactory
- 异常
-
FactoryConfigurationError
- 如果factoryClassName
是null
,或者无法加载工厂类,则实例化。 - 从以下版本开始:
- 1.6
- 另请参见:
-
newInstance()
-
newSAXParser
public abstract SAXParser newSAXParser() throws ParserConfigurationException, SAXException
使用当前配置的工厂参数创建SAXParser的新实例。- 结果
- SAXParser的新实例。
- 异常
-
ParserConfigurationException
- 如果无法创建满足请求配置的解析器。 -
SAXException
- 用于SAX错误。
-
setNamespaceAware
public void setNamespaceAware(boolean awareness)
指定此代码生成的解析器将提供对XML命名空间的支持。 默认情况下,此值设置为false
。- 参数
-
awareness
- 如果此代码生成的解析器将提供对XML命名空间的支持,awareness
true;否则为false。 否则是假的。
-
setValidating
public void setValidating(boolean validating)
指定此代码生成的解析器将在解析文档时验证它们。 默认情况下,this的值设置为false
。请注意,此处的“验证”表示XML建议中定义的a validating parser 。 换句话说,它基本上只是控制DTD验证。 (除了JAXP 1.2中定义的遗留两个属性。)
要使用现代模式语言(如W3C XML Schema或RELAX NG而不是DTD),可以将解析器配置为非验证解析器,方法是保留
setValidating(boolean)
方法false
,然后使用setSchema(Schema)
方法将模式关联到解析器。- 参数
-
validating
- 如果此代码生成的解析器将在解析文档时验证文档,validating
true;否则为false。 否则是假的。
-
isNamespaceAware
public boolean isNamespaceAware()
指示工厂是否配置为生成可识别名称空间的解析器。- 结果
- 如果工厂配置为生成可识别名称空间的解析器,则为true;否则为false。 否则是假的。
-
isValidating
public boolean isValidating()
指示工厂是否配置为生成在解析期间验证XML内容的解析器。- 结果
- 如果工厂配置为生成在解析期间验证XML内容的解析器,则为true;否则为false。 否则是假的。
-
setFeature
public abstract void setFeature(String name, boolean value) throws ParserConfigurationException, SAXNotRecognizedException, SAXNotSupportedException
设置org.xml.sax.XMLReader的底层实现中的特定功能。 可以在http://www.saxproject.org/找到核心特征和属性的列表所有实现都需要支持
XMLConstants.FEATURE_SECURE_PROCESSING
功能。 当功能是-
true
:实现将限制XML处理以符合实现限制。 示例包括实体扩展限制和消耗大量资源的XML Schema构造。 如果出于安全原因限制XML处理,则将通过调用已注册的ErrorHandler.fatalError(SAXParseException exception)
来报告。 有关处理程序规范,请参阅SAXParser
parse
方法。 - 当该特征是
false
,该实现将根据XML规范处理XML,而不考虑可能的实现限制。
- 参数
-
name
- 要设置的功能的名称。 -
value
- 要设置的功能的值。 - 异常
-
ParserConfigurationException
- 如果无法创建满足请求配置的解析器。 -
SAXNotRecognizedException
- 当基础XMLReader无法识别属性名称时。 -
SAXNotSupportedException
- 当基础XMLReader识别属性名称但不支持该属性时。 -
NullPointerException
- 如果name
参数为null。 - 另请参见:
-
XMLReader.setFeature(java.lang.String, boolean)
-
-
getFeature
public abstract boolean getFeature(String name) throws ParserConfigurationException, SAXNotRecognizedException, SAXNotSupportedException
返回org.xml.sax.XMLReader的底层实现中请求的特定属性。- 参数
-
name
- 要检索的属性的名称。 - 结果
- 要求财产的价值。
- 异常
-
ParserConfigurationException
- 如果无法创建满足请求配置的解析器。 -
SAXNotRecognizedException
- 当基础XMLReader无法识别属性名称时。 -
SAXNotSupportedException
- 当基础XMLReader识别属性名称但不支持该属性时。 - 另请参见:
-
XMLReader.getProperty(java.lang.String)
-
getSchema
public Schema getSchema()
获取通过setSchema(Schema schema)
方法指定的Schema
对象。- 结果
- 最后通过
setSchema(Schema)
方法设置的Schema
对象,如果自创建SAXParserFactory
后未调用该方法,则返回null。 - 异常
-
UnsupportedOperationException
- 当实现未覆盖此方法时 - 从以下版本开始:
- 1.5
-
setSchema
public void setSchema(Schema schema)
设置要从此工厂创建的解析器使用的Schema
。当
Schema
非空时,解析器将使用从其创建的验证程序在将信息传递给应用程序之前验证文档。当验证器发现警告/错误/致命错误时,解析器必须处理它们,就好像解析器本身找到了这些错误一样。 换句话说,如果设置了用户指定的
ErrorHandler
,它必须接收这些错误,如果没有,则必须根据特定于实现的默认错误处理规则来处理它们。验证器可以修改SAX事件流(例如,通过添加文档中缺少的默认值),并且解析器负责确保应用程序将接收这些修改的事件流。
最初,
null
设置为Schema
。即使
isValidating()
方法返回false
此处理也将生效。将
http://java.sun.com/xml/jaxp/properties/schemaSource
属性和/或http://java.sun.com/xml/jaxp/properties/schemaLanguage
属性与非nullSchema
对象结合使用时出错 。 这样的配置将导致SAXException
当这些属性上设置例外SAXParser
。实现者注意事项
解析器必须能够使用任何
Schema
实现。 但是,允许解析器和模式使用特定于实现的自定义机制,只要它们产生规范中描述的结果即可。- 参数
-
schema
-Schema
使用,null
删除架构。 - 异常
-
UnsupportedOperationException
- 实现未覆盖此方法时 - 从以下版本开始:
- 1.5
-
setXIncludeAware
public void setXIncludeAware(boolean state)
设置XInclude处理的状态。如果在文档实例中找到XInclude标记,是否应按XML Inclusions (XInclude) Version 1.0中的指定进行处理。
XInclude处理默认为
false
。- 参数
-
state
- 将XInclude处理设置为true
或false
- 异常
-
UnsupportedOperationException
- 实现未覆盖此方法时 - 从以下版本开始:
- 1.5
-
isXIncludeAware
public boolean isXIncludeAware()
获取XInclude处理的状态。- 结果
- XInclude处理的当前状态
- 异常
-
UnsupportedOperationException
- 实现未覆盖此方法时 - 从以下版本开始:
- 1.5
-
-