模块  java.xml
软件包  javax.xml.parsers

Class SAXParserFactory


  • public abstract class SAXParserFactory
    extends Object
    定义工厂API,使应用程序能够配置和获取基于SAX的解析器来解析XML文档。
    从以下版本开始:
    1.4
    • 构造方法详细信息

      • 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 - 如果 factoryClassNamenull ,或者无法加载工厂类,则实例化。
        从以下版本开始:
        1.6
        另请参见:
        newInstance()
      • 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。 否则是假的。
      • 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属性与非null Schema对象结合使用时出错 这样的配置将导致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处理设置为 truefalse
        异常
        UnsupportedOperationException - 实现未覆盖此方法时
        从以下版本开始:
        1.5
      • isXIncludeAware

        public boolean isXIncludeAware()
        获取XInclude处理的状态。
        结果
        XInclude处理的当前状态
        异常
        UnsupportedOperationException - 实现未覆盖此方法时
        从以下版本开始:
        1.5