⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
gnu.xml.pipeline

Class WellFormednessFilter

java.lang.Object
|
+--gnu.xml.pipeline.EventFilter
   |
   +--gnu.xml.pipeline.WellFormednessFilter


public final class WellFormednessFilter
extends EventFilter

This filter reports fatal exceptions in the case of event streams that are not well formed. The rules currently tested include:

Other checks for event stream correctness may be provided in the future. For example, insisting that entity boundaries nest correctly, namespace scopes nest correctly, namespace values never contain relative URIs, attributes don't have "<" characters; and more.

Author:
David Brownell

Constructor Summary

WellFormednessFilter()

Swallows all events after performing well formedness checks.

WellFormednessFilter(EventConsumer consumer)

Passes events through to the specified consumer, after first processing them.

Method Summary

void

characters(char ch[] , int start, int length)

void

comment(char ch[] , int start, int length)

void

endCDATA()

void

endDocument()

void

endDTD()

void

endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)

void

ignorableWhitespace(char ch[] , int start, int length)

void

notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId)

void

processingInstruction(java.lang.String target, java.lang.String data)

void

reset()

Resets state as if any preceding event stream was well formed.

void

setDocumentLocator(Locator locator)

Throws an exception when called after startDocument.

void

startCDATA()

void

startDocument()

void

startDTD(java.lang.String root, java.lang.String publicId, java.lang.String systemId)

void

startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, Attributes atts)

void

unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notationName)

Constructor Details

WellFormednessFilter

public WellFormednessFilter()

Swallows all events after performing well formedness checks.


WellFormednessFilter

public WellFormednessFilter(EventConsumer consumer)

Passes events through to the specified consumer, after first processing them.

Parameters:
consumer

Method Details

characters

public void characters(char ch[] , int start, int length)

Parameters:
start
length

comment

public void comment(char ch[] , int start, int length)

Parameters:
start
length

endCDATA

public void endCDATA()


endDocument

public void endDocument()


endDTD

public void endDTD()


endElement

public void endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)

Parameters:
uri
localName
qName

ignorableWhitespace

public void ignorableWhitespace(char ch[] , int start, int length)

Parameters:
start
length

notationDecl

public void notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId)

Parameters:
name
publicId
systemId

processingInstruction

public void processingInstruction(java.lang.String target, java.lang.String data)

Parameters:
target
data

reset

public void reset()

Resets state as if any preceding event stream was well formed. Particularly useful if it ended through some sort of error, and the endDocument call wasn't made.


setDocumentLocator

public void setDocumentLocator(Locator locator)

Throws an exception when called after startDocument.

Parameters:
locator - the locator, to be used in error reporting or relative URI resolution.
Throws:
java.lang.IllegalStateException - when called after the document has already been started

startCDATA

public void startCDATA()


startDocument

public void startDocument()


startDTD

public void startDTD(java.lang.String root, java.lang.String publicId, java.lang.String systemId)

Parameters:
root
publicId
systemId

startElement

public void startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, Attributes atts)

Parameters:
uri
localName
qName
atts

unparsedEntityDecl

public void unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notationName)

Parameters:
name
publicId
systemId
notationName