XmlLexicalHandler (JHOVE - JSTOR/Harvard Object Validation Environment 1.16.0 API)

java.lang.Object
- edu.harvard.hul.ois.jhove.module.xml.XmlLexicalHandler

All Implemented Interfaces:

LexicalHandler
```
public class XmlLexicalHandler
extends Object
implements LexicalHandler
```
This implementation of LexicalHandler takes care of comments, DTD's, entities and other stuff for XmlModule. The caller has to make sure the LexicalHandler property is supported by the SAX implementation, and set that property to this class.

Author:

Gary McGath

Constructor Summary

Constructors
Constructor and Description

XmlLexicalHandler()

Constructors
Constructor and Description
`XmlLexicalHandler()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`comment(char[] text, int start, int length)` Gathers comments into the comments list.
`void`	`endCDATA()` Report the end of a CDATA section.
`void`	`endDTD()` Report the end of DTD declarations.
`void`	`endEntity(String name)` Report the end of an entity.
`List<String>`	`getComments()` Returns the value of the comments list, which is a List of Strings.
`Set<String>`	`getEntityNames()` Returns the Set of entity names.
`void`	`startCDATA()` Report the start of a CDATA section.
`void`	`startDTD(String arg0, String arg1, String arg2)` Report the start of DTD declarations, if any.
`void`	`startEntity(String name)` Accumulates entity names into the entity set.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - XmlLexicalHandler
```
public XmlLexicalHandler()
```
- Method Detail
  - endCDATA
```
public void endCDATA()
              throws SAXException
```
    Report the end of a CDATA section. Does nothing.
    
    Specified by:
    
    endCDATA in interface LexicalHandler
    
    Throws:
    
    SAXException
    
    See Also:
    
    LexicalHandler.endCDATA()
  - endDTD
```
public void endDTD()
            throws SAXException
```
    Report the end of DTD declarations. Does nothing.
    
    Specified by:
    
    endDTD in interface LexicalHandler
    
    Throws:
    
    SAXException
    
    See Also:
    
    LexicalHandler.endDTD()
  - startCDATA
```
public void startCDATA()
                throws SAXException
```
    Report the start of a CDATA section. Does nothing.
    
    Specified by:
    
    startCDATA in interface LexicalHandler
    
    Throws:
    
    SAXException
    
    See Also:
    
    LexicalHandler.startCDATA()
  - comment
```
public void comment(char[] text,
                    int start,
                    int length)
             throws SAXException
```
    Gathers comments into the comments list.
    
    Specified by:
    
    comment in interface LexicalHandler
    
    Throws:
    
    SAXException
    
    See Also:
    
    LexicalHandler.comment(char[], int, int)
  - startEntity
```
public void startEntity(String name)
                 throws SAXException
```
    Accumulates entity names into the entity set. This will be used for determining which entities are actually used.
    
    Specified by:
    
    startEntity in interface LexicalHandler
    
    Throws:
    
    SAXException
    
    See Also:
    
    LexicalHandler.startEntity(java.lang.String)
  - endEntity
```
public void endEntity(String name)
               throws SAXException
```
    Report the end of an entity. Does nothing.
    
    Specified by:
    
    endEntity in interface LexicalHandler
    
    Throws:
    
    SAXException
    
    See Also:
    
    LexicalHandler.endEntity(java.lang.String)
  - startDTD
```
public void startDTD(String arg0,
                     String arg1,
                     String arg2)
              throws SAXException
```
    Report the start of DTD declarations, if any. Does nothing.
    
    Specified by:
    
    startDTD in interface LexicalHandler
    
    Throws:
    
    SAXException
    
    See Also:
    
    LexicalHandler.startDTD(java.lang.String, java.lang.String, java.lang.String)
  - getComments
```
public List<String> getComments()
```
    Returns the value of the comments list, which is a List of Strings.
  - getEntityNames
```
public Set<String> getEntityNames()
```
    Returns the Set of entity names.

Class XmlLexicalHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

XmlLexicalHandler

Method Detail

endCDATA

endDTD

startCDATA

comment

startEntity

endEntity

startDTD

getComments

getEntityNames