WellFormednessFilter (GNU JAXP Library)

Overview

Package

Class

Use

Tree

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

gnu.xml.pipeline
Class WellFormednessFilter

java.lang.Object
  gnu.xml.pipeline.EventFilter
      gnu.xml.pipeline.WellFormednessFilter

All Implemented Interfaces:: ContentHandler, DeclHandler, DTDHandler, EventConsumer, LexicalHandler

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:

setDocumentLocator ... may be called only before startDocument
startDocument/endDocument ... must be paired, and all other calls (except setDocumentLocator) must be nested within these.
startElement/endElement ... must be correctly paired, and may never appear within CDATA sections.
comment ... can't contain "--"
character data ... can't contain "]]>"
whitespace ... can't contain CR
whitespace and character data must be within an element
processing instruction ... can't contain "?>" or CR
startCDATA/endCDATA ... must be correctly paired.

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.

Version:: $Date: 2001/11/09 22:53:17 $
Author:: David Brownell

Field Summary

Fields inherited from class gnu.xml.pipeline.EventFilter

DECL_HANDLER, FEATURE_URI, LEXICAL_HANDLER, PROPERTY_URI

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)` SAX2: passes this callback to the next consumer, if any
`void`	`comment(char[] ch, int start, int length)` SAX2: passes this callback to the next consumer, if any
`void`	`endCDATA()` SAX2: passes this callback to the next consumer, if any
`void`	`endDocument()` SAX2: passes this callback to the next consumer, if any
`void`	`endDTD()` SAX2: passes this callback to the next consumer, if any
`void`	`endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName)` SAX2: passes this callback to the next consumer, if any
`void`	`ignorableWhitespace(char[] ch, int start, int length)` SAX2: passes this callback to the next consumer, if any
`void`	`notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId)` SAX1: passes this callback to the next consumer, if any
`void`	`processingInstruction(java.lang.String target, java.lang.String data)` SAX2: passes this callback to the next consumer, if any
`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()` SAX2: passes this callback to the next consumer, if any
`void`	`startDocument()` SAX2: passes this callback to the next consumer, if any
`void`	`startDTD(java.lang.String root, java.lang.String publicId, java.lang.String systemId)` SAX2: passes this callback to the next consumer, if any
`void`	`startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, Attributes atts)` SAX2: passes this callback to the next consumer, if any
`void`	`unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notationName)` SAX1: passes this callback to the next consumer, if any

Methods inherited from class gnu.xml.pipeline.EventFilter

attributeDecl, bind, chainTo, elementDecl, endEntity, endPrefixMapping, externalEntityDecl, getContentHandler, getDocumentLocator, getDTDHandler, getErrorHandler, getNext, getProperty, internalEntityDecl, setContentHandler, setDTDHandler, setErrorHandler, setProperty, skippedEntity, startEntity, startPrefixMapping

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

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.

Method Detail

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.

Specified by:: setDocumentLocator in interface ContentHandler
Overrides:: setDocumentLocator in class EventFilter

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