SAXHandler

java.lang.Object
- org.xml.sax.helpers.DefaultHandler
- - org.jdom2.input.sax.SAXHandler

所有已实现的接口:

org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler, org.xml.sax.ext.DeclHandler, org.xml.sax.ext.LexicalHandler
```
public class SAXHandler
extends org.xml.sax.helpers.DefaultHandler
implements org.xml.sax.ext.LexicalHandler, org.xml.sax.ext.DeclHandler, org.xml.sax.DTDHandler
```
A support class for SAXBuilder which listens for SAX events.
People overriding this class are cautioned to ensure that the implementation of the cleanUp() method resets to a virgin state. The cleanUp() method will be called when this SAXHandler is reset(), which may happen multiple times between parses. The cleanUp() method must ensure that there are no references remaining to any external instances.
Overriding of this class is permitted to allow for different handling of SAX events. Once you have created a subclass of this, you also need to create a custom implementation of SAXHandlerFactory to supply your instances to SAXBuilder
If the XMLReader producing the SAX Events supports a document Locator, then this instance will use the locator to supply the line and column data from the SAX locator to the JDOMFactory. Note: the SAX specification for the SAX Locator indicates that the line and column represent the position of the end of the SAX Event. For example, the line and column of the simple XML <root /> would be line 1, column 9.

作者:

Brett McLaughlin, Jason Hunter, Philip Nelson, Bradley S. Huffman, phil@triloggroup.com, Rolf Lear

另请参阅:

org.jdom2.input.sax

构造器概要

构造器
构造器和说明
`SAXHandler()` This will create a new `SAXHandler` that listens to SAX events and creates a JDOM Document.
`SAXHandler(JDOMFactory factory)` This will create a new `SAXHandler` that listens to SAX events and creates a JDOM Document.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`attributeDecl(java.lang.String eName, java.lang.String aName, java.lang.String type, java.lang.String valueDefault, java.lang.String value)` This handles an attribute declaration in the internal subset.
`void`	`characters(char[] ch, int start, int length)` This will report character data (within an element).
`void`	`comment(char[] ch, int start, int length)` This reports that a comments is parsed.
`void`	`elementDecl(java.lang.String name, java.lang.String model)` Handle an element declaration in a DTD.
`void`	`endCDATA()` Report a CDATA section
`void`	`endDTD()` This signifies that the reading of the DTD is complete.
`void`	`endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName)` Indicates the end of an element (`</[element name]>`) is reached.
`void`	`endEntity(java.lang.String name)`
`void`	`externalEntityDecl(java.lang.String name, java.lang.String publicID, java.lang.String systemID)` This is called when the parser encounters an external entity declaration.
`Element`	`getCurrentElement()` Returns the being-parsed element.
`Document`	`getDocument()` Returns the document.
`org.xml.sax.Locator`	`getDocumentLocator()` Provides access to the `Locator` object provided by the SAX parser.
`boolean`	`getExpandEntities()` Returns whether or not entities will be expanded during the build.
`JDOMFactory`	`getFactory()` Returns the factory used for constructing objects.
`boolean`	`getIgnoringBoundaryWhitespace()` Returns whether or not the parser will elminate element content containing only whitespace.
`boolean`	`getIgnoringElementContentWhitespace()` Returns whether or not the parser will elminate whitespace in element content (sometimes known as "ignorable whitespace") when building the document.
`void`	`ignorableWhitespace(char[] ch, int start, int length)` Capture ignorable whitespace as text.
`void`	`internalEntityDecl(java.lang.String name, java.lang.String value)` Handle an internal entity declaration in a DTD.
`void`	`notationDecl(java.lang.String name, java.lang.String publicID, java.lang.String systemID)` Handle the declaration of a Notation in a DTD
`void`	`processingInstruction(java.lang.String target, java.lang.String data)` This will indicate that a processing instruction has been encountered.
`void`	`reset()` Restore this SAXHandler to a clean state ready for another parse round.
`void`	`setDocumentLocator(org.xml.sax.Locator locator)` Receives an object for locating the origin of SAX document events.
`void`	`setExpandEntities(boolean expand)` This sets whether or not to expand entities during the build.
`void`	`setIgnoringBoundaryWhitespace(boolean ignoringBoundaryWhite)` Specifies whether or not the parser should eliminate text() nodes containing only whitespace when building the document.
`void`	`setIgnoringElementContentWhitespace(boolean ignoringWhite)` Specifies whether or not the parser should elminate whitespace in element content (sometimes known as "ignorable whitespace") when building the document.
`void`	`skippedEntity(java.lang.String name)` This indicates that an unresolvable entity reference has been encountered, normally because the external DTD subset has not been read.
`void`	`startCDATA()` Report a CDATA section
`void`	`startDocument()`
`void`	`startDTD(java.lang.String name, java.lang.String publicID, java.lang.String systemID)` This will signify that a DTD is being parsed, and can be used to ensure that comments and other lexical structures in the DTD are not added to the JDOM `Document` object.
`void`	`startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)` This reports the occurrence of an actual element.
`void`	`startEntity(java.lang.String name)`
`void`	`startPrefixMapping(java.lang.String prefix, java.lang.String uri)` This will add the prefix mapping to the JDOM `Document` object.
`void`	`unparsedEntityDecl(java.lang.String name, java.lang.String publicID, java.lang.String systemID, java.lang.String notationName)` Handler for unparsed entity declarations in the DTD

从类继承的方法 org.xml.sax.helpers.DefaultHandler
endDocument, endPrefixMapping, error, fatalError, resolveEntity, warning

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - SAXHandler
```
public SAXHandler()
```
    This will create a new SAXHandler that listens to SAX events and creates a JDOM Document. The objects will be constructed using the default factory.
  - SAXHandler
```
public SAXHandler(JDOMFactory factory)
```
    This will create a new SAXHandler that listens to SAX events and creates a JDOM Document. The objects will be constructed using the provided factory.
    
    参数:
    
    factory - JDOMFactory to be used for constructing objects
- 方法详细资料
  - reset
```
public final void reset()
```
    Restore this SAXHandler to a clean state ready for another parse round. All internal variables are cleared to an initialized state, and then the resetSubClass() method is called to clear any methods that a subclass may need to have reset.
  - getDocument
```
public Document getDocument()
```
    Returns the document. Should be called after parsing is complete.
    
    返回:
    
    Document - Document that was built
  - getFactory
```
public JDOMFactory getFactory()
```
    Returns the factory used for constructing objects.
    
    返回:
    
    JDOMFactory - the factory used for constructing objects.
    
    另请参阅:
    
    SAXHandler(org.jdom2.JDOMFactory)
  - setExpandEntities
```
public void setExpandEntities(boolean expand)
```
    This sets whether or not to expand entities during the build. A true means to expand entities as normal content. A false means to leave entities unexpanded as EntityRef objects. The default is true.
    
    参数:
    
    expand - boolean indicating whether entity expansion should occur.
  - getExpandEntities
```
public boolean getExpandEntities()
```
    Returns whether or not entities will be expanded during the build.
    
    返回:
    
    boolean - whether entity expansion will occur during build.
    
    另请参阅:
    
    setExpandEntities(boolean)
  - setIgnoringElementContentWhitespace
```
public void setIgnoringElementContentWhitespace(boolean ignoringWhite)
```
    Specifies whether or not the parser should elminate whitespace in element content (sometimes known as "ignorable whitespace") when building the document. Only whitespace which is contained within element content that has an element only content model will be eliminated (see XML Rec 3.2.1). For this setting to take effect requires that validation be turned on. The default value of this setting is false.
    
    参数:
    
    ignoringWhite - Whether to ignore ignorable whitespace
  - setIgnoringBoundaryWhitespace
```
public void setIgnoringBoundaryWhitespace(boolean ignoringBoundaryWhite)
```
    Specifies whether or not the parser should eliminate text() nodes containing only whitespace when building the document. See SAXBuilder.setIgnoringBoundaryWhitespace(boolean).
    
    参数:
    
    ignoringBoundaryWhite - Whether to ignore only whitespace content
  - getIgnoringBoundaryWhitespace
```
public boolean getIgnoringBoundaryWhitespace()
```
    Returns whether or not the parser will elminate element content containing only whitespace.
    
    返回:
    
    boolean - whether only whitespace content will be ignored during build.
    
    另请参阅:
    
    setIgnoringBoundaryWhitespace(boolean)
  - getIgnoringElementContentWhitespace
```
public boolean getIgnoringElementContentWhitespace()
```
    Returns whether or not the parser will elminate whitespace in element content (sometimes known as "ignorable whitespace") when building the document.
    
    返回:
    
    boolean - whether ignorable whitespace will be ignored during build.
    
    另请参阅:
    
    setIgnoringElementContentWhitespace(boolean)
  - startDocument
```
public void startDocument()
```
    指定者:
    
    startDocument 在接口中 org.xml.sax.ContentHandler
    
    覆盖:
    
    startDocument 在类中 org.xml.sax.helpers.DefaultHandler
  - externalEntityDecl
```
public void externalEntityDecl(java.lang.String name,
                               java.lang.String publicID,
                               java.lang.String systemID)
                        throws org.xml.sax.SAXException
```
    This is called when the parser encounters an external entity declaration.
    
    指定者:
    
    externalEntityDecl 在接口中 org.xml.sax.ext.DeclHandler
    
    参数:
    
    name - entity name
    
    publicID - public id
    
    systemID - system id
    
    抛出:
    
    org.xml.sax.SAXException - when things go wrong
  - attributeDecl
```
public void attributeDecl(java.lang.String eName,
                          java.lang.String aName,
                          java.lang.String type,
                          java.lang.String valueDefault,
                          java.lang.String value)
```
    This handles an attribute declaration in the internal subset.
    
    指定者:
    
    attributeDecl 在接口中 org.xml.sax.ext.DeclHandler
    
    参数:
    
    eName - String element name of attribute
    
    aName - String attribute name
    
    type - String attribute type
    
    valueDefault - String default value of attribute
    
    value - String value of attribute
  - elementDecl
```
public void elementDecl(java.lang.String name,
                        java.lang.String model)
```
    Handle an element declaration in a DTD.
    
    指定者:
    
    elementDecl 在接口中 org.xml.sax.ext.DeclHandler
    
    参数:
    
    name - String name of element
    
    model - String model of the element in DTD syntax
  - internalEntityDecl
```
public void internalEntityDecl(java.lang.String name,
                               java.lang.String value)
```
    Handle an internal entity declaration in a DTD.
    
    指定者:
    
    internalEntityDecl 在接口中 org.xml.sax.ext.DeclHandler
    
    参数:
    
    name - String name of entity
    
    value - String value of the entity
  - processingInstruction
```
public void processingInstruction(java.lang.String target,
                                  java.lang.String data)
                           throws org.xml.sax.SAXException
```
    This will indicate that a processing instruction has been encountered. (The XML declaration is not a processing instruction and will not be reported.)
    
    指定者:
    
    processingInstruction 在接口中 org.xml.sax.ContentHandler
    
    覆盖:
    
    processingInstruction 在类中 org.xml.sax.helpers.DefaultHandler
    
    参数:
    
    target - String target of PI
    
    data - String containing all data sent to the PI. This typically looks like one or more attribute value pairs.
    
    抛出:
    
    org.xml.sax.SAXException - when things go wrong
  - skippedEntity
```
public void skippedEntity(java.lang.String name)
                   throws org.xml.sax.SAXException
```
    This indicates that an unresolvable entity reference has been encountered, normally because the external DTD subset has not been read.
    
    指定者:
    
    skippedEntity 在接口中 org.xml.sax.ContentHandler
    
    覆盖:
    
    skippedEntity 在类中 org.xml.sax.helpers.DefaultHandler
    
    参数:
    
    name - String name of entity
    
    抛出:
    
    org.xml.sax.SAXException - when things go wrong
  - startPrefixMapping
```
public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String uri)
                        throws org.xml.sax.SAXException
```
    This will add the prefix mapping to the JDOM Document object.
    
    指定者:
    
    startPrefixMapping 在接口中 org.xml.sax.ContentHandler
    
    覆盖:
    
    startPrefixMapping 在类中 org.xml.sax.helpers.DefaultHandler
    
    参数:
    
    prefix - String namespace prefix.
    
    uri - String namespace URI.
    
    抛出:
    
    org.xml.sax.SAXException
  - startElement
```
public void startElement(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes atts)
                  throws org.xml.sax.SAXException
```
    This reports the occurrence of an actual element. It will include the element's attributes, with the exception of XML vocabulary specific attributes, such as xmlns:[namespace prefix] and xsi:schemaLocation.
    
    指定者:
    
    startElement 在接口中 org.xml.sax.ContentHandler
    
    覆盖:
    
    startElement 在类中 org.xml.sax.helpers.DefaultHandler
    
    参数:
    
    namespaceURI - String namespace URI this element is associated with, or an empty String
    
    localName - String name of element (with no namespace prefix, if one is present)
    
    qName - String XML 1.0 version of element name: [namespace prefix]:[localName]
    
    atts - Attributes list for this element
    
    抛出:
    
    org.xml.sax.SAXException - when things go wrong
  - characters
```
public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException
```
    This will report character data (within an element).
    
    指定者:
    
    characters 在接口中 org.xml.sax.ContentHandler
    
    覆盖:
    
    characters 在类中 org.xml.sax.helpers.DefaultHandler
    
    参数:
    
    ch - char[] character array with character data
    
    start - int index in array where data starts.
    
    length - int length of data.
    
    抛出:
    
    org.xml.sax.SAXException
  - ignorableWhitespace
```
public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)
                         throws org.xml.sax.SAXException
```
    Capture ignorable whitespace as text. If setIgnoringElementContentWhitespace(true) has been called then this method does nothing.
    
    指定者:
    
    ignorableWhitespace 在接口中 org.xml.sax.ContentHandler
    
    覆盖:
    
    ignorableWhitespace 在类中 org.xml.sax.helpers.DefaultHandler
    
    参数:
    
    ch - [] - char array of ignorable whitespace
    
    start - int - starting position within array
    
    length - int - length of whitespace after start
    
    抛出:
    
    org.xml.sax.SAXException - when things go wrong
  - endElement
```
public void endElement(java.lang.String namespaceURI,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException
```
    Indicates the end of an element (</[element name]>) is reached. Note that the parser does not distinguish between empty elements and non-empty elements, so this will occur uniformly.
    
    指定者:
    
    endElement 在接口中 org.xml.sax.ContentHandler
    
    覆盖:
    
    endElement 在类中 org.xml.sax.helpers.DefaultHandler
    
    参数:
    
    namespaceURI - String URI of namespace this element is associated with
    
    localName - String name of element without prefix
    
    qName - String name of element in XML 1.0 form
    
    抛出:
    
    org.xml.sax.SAXException - when things go wrong
  - startDTD
```
public void startDTD(java.lang.String name,
                     java.lang.String publicID,
                     java.lang.String systemID)
              throws org.xml.sax.SAXException
```
    This will signify that a DTD is being parsed, and can be used to ensure that comments and other lexical structures in the DTD are not added to the JDOM Document object.
    
    指定者:
    
    startDTD 在接口中 org.xml.sax.ext.LexicalHandler
    
    参数:
    
    name - String name of element listed in DTD
    
    publicID - String public ID of DTD
    
    systemID - String system ID of DTD
    
    抛出:
    
    org.xml.sax.SAXException
  - endDTD
```
public void endDTD()
```
    This signifies that the reading of the DTD is complete.
    
    指定者:
    
    endDTD 在接口中 org.xml.sax.ext.LexicalHandler
  - startEntity
```
public void startEntity(java.lang.String name)
                 throws org.xml.sax.SAXException
```
    指定者:
    
    startEntity 在接口中 org.xml.sax.ext.LexicalHandler
    
    抛出:
    
    org.xml.sax.SAXException
  - endEntity
```
public void endEntity(java.lang.String name)
               throws org.xml.sax.SAXException
```
    指定者:
    
    endEntity 在接口中 org.xml.sax.ext.LexicalHandler
    
    抛出:
    
    org.xml.sax.SAXException
  - startCDATA
```
public void startCDATA()
```
    Report a CDATA section
    
    指定者:
    
    startCDATA 在接口中 org.xml.sax.ext.LexicalHandler
  - endCDATA
```
public void endCDATA()
              throws org.xml.sax.SAXException
```
    Report a CDATA section
    
    指定者:
    
    endCDATA 在接口中 org.xml.sax.ext.LexicalHandler
    
    抛出:
    
    org.xml.sax.SAXException
  - comment
```
public void comment(char[] ch,
                    int start,
                    int length)
             throws org.xml.sax.SAXException
```
    This reports that a comments is parsed. If not in the DTD, this comment is added to the current JDOM Element, or the Document itself if at that level.
    
    指定者:
    
    comment 在接口中 org.xml.sax.ext.LexicalHandler
    
    参数:
    
    ch - ch[] array of comment characters.
    
    start - int index to start reading from.
    
    length - int length of data.
    
    抛出:
    
    org.xml.sax.SAXException - if the state of the handler disallows this call
  - notationDecl
```
public void notationDecl(java.lang.String name,
                         java.lang.String publicID,
                         java.lang.String systemID)
                  throws org.xml.sax.SAXException
```
    Handle the declaration of a Notation in a DTD
    
    指定者:
    
    notationDecl 在接口中 org.xml.sax.DTDHandler
    
    覆盖:
    
    notationDecl 在类中 org.xml.sax.helpers.DefaultHandler
    
    参数:
    
    name - name of the notation
    
    publicID - the public ID of the notation
    
    systemID - the system ID of the notation
    
    抛出:
    
    org.xml.sax.SAXException
  - unparsedEntityDecl
```
public void unparsedEntityDecl(java.lang.String name,
                               java.lang.String publicID,
                               java.lang.String systemID,
                               java.lang.String notationName)
```
    Handler for unparsed entity declarations in the DTD
    
    指定者:
    
    unparsedEntityDecl 在接口中 org.xml.sax.DTDHandler
    
    覆盖:
    
    unparsedEntityDecl 在类中 org.xml.sax.helpers.DefaultHandler
    
    参数:
    
    name - String of the unparsed entity decl
    
    publicID - String of the unparsed entity decl
    
    systemID - String of the unparsed entity decl
    
    notationName - String of the unparsed entity decl
  - getCurrentElement
```
public Element getCurrentElement()
                          throws org.xml.sax.SAXException
```
    Returns the being-parsed element.
    
    返回:
    
    Element - element being built.
    
    抛出:
    
    org.xml.sax.SAXException - if the state of the handler disallows this call
  - setDocumentLocator
```
public void setDocumentLocator(org.xml.sax.Locator locator)
```
    Receives an object for locating the origin of SAX document events. This method is invoked by the SAX parser.
    JDOMFactory implementations can use the getDocumentLocator() method to get access to the Locator during parse.
    
    指定者:
    
    setDocumentLocator 在接口中 org.xml.sax.ContentHandler
    
    覆盖:
    
    setDocumentLocator 在类中 org.xml.sax.helpers.DefaultHandler
    
    参数:
    
    locator - Locator an object that can return the location of any SAX document event.
  - getDocumentLocator
```
public org.xml.sax.Locator getDocumentLocator()
```
    Provides access to the Locator object provided by the SAX parser.
    
    返回:
    
    Locator an object that can return the location of any SAX document event.

类 SAXHandler

构造器概要

方法概要

从类继承的方法 org.xml.sax.helpers.DefaultHandler

从类继承的方法 java.lang.Object

构造器详细资料

SAXHandler

SAXHandler

方法详细资料

reset

getDocument

getFactory

setExpandEntities

getExpandEntities

setIgnoringElementContentWhitespace

setIgnoringBoundaryWhitespace

getIgnoringBoundaryWhitespace

getIgnoringElementContentWhitespace

startDocument

externalEntityDecl

attributeDecl

elementDecl

internalEntityDecl

processingInstruction

skippedEntity

startPrefixMapping

startElement

characters

ignorableWhitespace

endElement

startDTD

endDTD

startEntity

endEntity

startCDATA

endCDATA

comment

notationDecl

unparsedEntityDecl

getCurrentElement

setDocumentLocator

getDocumentLocator