gnu.xml.pipeline

Class WellFormednessFilter

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:

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.

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

Methods inherited from class gnu.xml.pipeline.EventFilter

attributeDecl, bind, chainTo, characters, comment, elementDecl, endCDATA, endDTD, endDocument, endElement, endEntity, endPrefixMapping, externalEntityDecl, getContentHandler, getDTDHandler, getDocumentLocator, getErrorHandler, getNext, getProperty, ignorableWhitespace, internalEntityDecl, notationDecl, processingInstruction, setContentHandler, setDTDHandler, setDocumentLocator, setErrorHandler, setProperty, skippedEntity, startCDATA, startDTD, startDocument, startElement, startEntity, startPrefixMapping, unparsedEntityDecl

Methods inherited from class java.lang.Object

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

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.

Method Details

characters

public void characters(ch[] ,
                       int start,
                       int length)
            throws SAXException
SAX2: passes this callback to the next consumer, if any
Overrides:
characters in interface EventFilter

comment

public void comment(ch[] ,
                    int start,
                    int length)
            throws SAXException
SAX2: passes this callback to the next consumer, if any
Overrides:
comment in interface EventFilter

endCDATA

public void endCDATA()
            throws SAXException
SAX2: passes this callback to the next consumer, if any
Overrides:
endCDATA in interface EventFilter

endDTD

public void endDTD()
            throws SAXException
SAX2: passes this callback to the next consumer, if any
Overrides:
endDTD in interface EventFilter

endDocument

public void endDocument()
            throws SAXException
SAX2: passes this callback to the next consumer, if any
Overrides:
endDocument in interface EventFilter

endElement

public void endElement(String uri,
                       String localName,
                       String qName)
            throws SAXException
SAX2: passes this callback to the next consumer, if any
Overrides:
endElement in interface EventFilter

ignorableWhitespace

public void ignorableWhitespace(ch[] ,
                                int start,
                                int length)
            throws SAXException
SAX2: passes this callback to the next consumer, if any
Overrides:
ignorableWhitespace in interface EventFilter

notationDecl

public void notationDecl(String name,
                         String publicId,
                         String systemId)
            throws SAXException
SAX1: passes this callback to the next consumer, if any
Overrides:
notationDecl in interface EventFilter

processingInstruction

public void processingInstruction(String target,
                                  String data)
            throws SAXException
SAX2: passes this callback to the next consumer, if any
Overrides:
processingInstruction in interface EventFilter

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.
Overrides:
setDocumentLocator in interface EventFilter
Parameters:
locator - the locator, to be used in error reporting or relative URI resolution.
Throws:
IllegalStateException - when called after the document has already been started

startCDATA

public void startCDATA()
            throws SAXException
SAX2: passes this callback to the next consumer, if any
Overrides:
startCDATA in interface EventFilter

startDTD

public void startDTD(String root,
                     String publicId,
                     String systemId)
            throws SAXException
SAX2: passes this callback to the next consumer, if any
Overrides:
startDTD in interface EventFilter

startDocument

public void startDocument()
            throws SAXException
SAX2: passes this callback to the next consumer, if any
Overrides:
startDocument in interface EventFilter

startElement

public void startElement(String uri,
                         String localName,
                         String qName,
                         Attributes atts)
            throws SAXException
SAX2: passes this callback to the next consumer, if any
Overrides:
startElement in interface EventFilter

unparsedEntityDecl

public void unparsedEntityDecl(String name,
                               String publicId,
                               String systemId,
                               String notationName)
            throws SAXException
SAX1: passes this callback to the next consumer, if any
Overrides:
unparsedEntityDecl in interface EventFilter

WellFormednessFilter.java -- Copyright (C) 1999,2000,2001 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.