Top Description Fields Constructors Methods
com.sun.msv.util.xml

public Class DocumentFilter

extends Object
implements DocumentHandler
Class Inheritance
All Implemented Interfaces
org.xml.sax.DocumentHandler
Annotations
@SuppressWarnings:deprecation
Imports
org.xml.sax.AttributeList, .DocumentHandler, .Locator, .SAXException

Deprecated

as a consequence of DocumentHandler being deprecated. See corresponding docs for further information.

SAX DocumentHandler event interceptor. This object acts as a filter to DocumentHandler events. Derived class should override methods of interest and perform somethings.
Author
Kohsuke KAWAGUCHI

Field Summary

Modifier and TypeField and Description
public DocumentHandler
next

Deprecated as a consequence of DocumentHandler being deprecated.

Constructor Summary

AccessConstructor and Description
public
DocumentFilter(DocumentHandler next)

Deprecated as a consequence of DocumentHandler being deprecated.

Method Summary

Modifier and TypeMethod and Description
public void
characters(char[]
The characters from the XML document.
buf
,
int
The start position in the array.
start
,
int
The number of characters to read from the array.
len
)

Implements org.xml.sax.DocumentHandler.characters.

Receive notification of character data.
public void
endDocument()

Implements org.xml.sax.DocumentHandler.endDocument.

Receive notification of the end of a document.
public void
endElement(String
The element type name
name
)

Implements org.xml.sax.DocumentHandler.endElement.

Receive notification of the end of an element.
public void
ignorableWhitespace(char[]
The characters from the XML document.
buf
,
int
The start position in the array.
start
,
int
The number of characters to read from the array.
len
)

Implements org.xml.sax.DocumentHandler.ignorableWhitespace.

Receive notification of ignorable whitespace in element content.
public void
processingInstruction(String
The processing instruction target.
target
,
String
The processing instruction data, or null if none was supplied.
data
)

Implements org.xml.sax.DocumentHandler.processingInstruction.

Receive notification of a processing instruction.
public void
setDocumentLocator(Locator
An object that can return the location of any SAX document event.
loc
)

Implements org.xml.sax.DocumentHandler.setDocumentLocator.

Receive an object for locating the origin of SAX document events.
public void
startDocument()

Implements org.xml.sax.DocumentHandler.startDocument.

Receive notification of the beginning of a document.
public void
startElement(String
The element type name.
name
,
AttributeList
The attributes attached to the element, if any.
atts
)

Implements org.xml.sax.DocumentHandler.startElement.

Deprecated as a consequence of AttributeList being deprecated.
Receive notification of the beginning of an element.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

nextback to summary
public DocumentHandler next

Deprecated

as a consequence of DocumentHandler being deprecated. See corresponding docs for further information.

Constructor Detail

DocumentFilterback to summary
public DocumentFilter(DocumentHandler next)

Deprecated

as a consequence of DocumentHandler being deprecated. See corresponding docs for further information.

Method Detail

charactersback to summary
public void characters(char[] buf, int start, int len) throws SAXException

Implements org.xml.sax.DocumentHandler.characters.

Doc from org.xml.sax.DocumentHandler.characters.

Receive notification of character data.

The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.

The application must not attempt to read from the array outside of the specified range.

Note that some parsers will report whitespace using the ignorableWhitespace() method rather than this one (validating parsers must do so).

Parameters
buf:char[]

The characters from the XML document.

start:int

The start position in the array.

len:int

The number of characters to read from the array.

Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
endDocumentback to summary
public void endDocument() throws SAXException

Implements org.xml.sax.DocumentHandler.endDocument.

Doc from org.xml.sax.DocumentHandler.endDocument.

Receive notification of the end of a document.

The SAX parser will invoke this method only once, and it will be the last method invoked during the parse. The parser shall not invoke this method until it has either abandoned parsing (because of an unrecoverable error) or reached the end of input.

Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
endElementback to summary
public void endElement(String name) throws SAXException

Implements org.xml.sax.DocumentHandler.endElement.

Doc from org.xml.sax.DocumentHandler.endElement.

Receive notification of the end of an element.

The SAX parser will invoke this method at the end of every element in the XML document; there will be a corresponding startElement() event for every endElement() event (even when the element is empty).

If the element name has a namespace prefix, the prefix will still be attached to the name.

Parameters
name:String

The element type name

Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
ignorableWhitespaceback to summary
public void ignorableWhitespace(char[] buf, int start, int len) throws SAXException

Implements org.xml.sax.DocumentHandler.ignorableWhitespace.

Doc from org.xml.sax.DocumentHandler.ignorableWhitespace.

Receive notification of ignorable whitespace in element content.

Validating Parsers must use this method to report each chunk of ignorable whitespace (see the W3C XML 1.0 recommendation, section 2.10): non-validating parsers may also use this method if they are capable of parsing and using content models.

SAX parsers may return all contiguous whitespace in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.

The application must not attempt to read from the array outside of the specified range.

Parameters
buf:char[]

The characters from the XML document.

start:int

The start position in the array.

len:int

The number of characters to read from the array.

Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
processingInstructionback to summary
public void processingInstruction(String target, String data) throws SAXException

Implements org.xml.sax.DocumentHandler.processingInstruction.

Doc from org.xml.sax.DocumentHandler.processingInstruction.

Receive notification of a processing instruction.

The Parser will invoke this method once for each processing instruction found: note that processing instructions may occur before or after the main document element.

A SAX parser should never report an XML declaration (XML 1.0, section 2.8) or a text declaration (XML 1.0, section 4.3.1) using this method.

Parameters
target:String

The processing instruction target.

data:String

The processing instruction data, or null if none was supplied.

Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
setDocumentLocatorback to summary
public void setDocumentLocator(Locator loc)

Implements org.xml.sax.DocumentHandler.setDocumentLocator.

Doc from org.xml.sax.DocumentHandler.setDocumentLocator.

Receive an object for locating the origin of SAX document events.

SAX parsers are strongly encouraged (though not absolutely required) to supply a locator: if it does so, it must supply the locator to the application by invoking this method before invoking any of the other methods in the DocumentHandler interface.

The locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application will use this information for reporting its own errors (such as character content that does not match an application's business rules). The information returned by the locator is probably not sufficient for use with a search engine.

Note that the locator will return correct information only during the invocation of the events in this interface. The application should not attempt to use it at any other time.

Parameters
loc:Locator

An object that can return the location of any SAX document event.

startDocumentback to summary
public void startDocument() throws SAXException

Implements org.xml.sax.DocumentHandler.startDocument.

Doc from org.xml.sax.DocumentHandler.startDocument.

Receive notification of the beginning of a document.

The SAX parser will invoke this method only once, before any other methods in this interface or in DTDHandler (except for setDocumentLocator).

Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.
startElementback to summary
public void startElement(String name, AttributeList atts) throws SAXException

Implements org.xml.sax.DocumentHandler.startElement.

Doc from org.xml.sax.DocumentHandler.startElement.

Deprecated

as a consequence of AttributeList being deprecated. See corresponding docs for further information.

Receive notification of the beginning of an element.

The Parser will invoke this method at the beginning of every element in the XML document; there will be a corresponding endElement() event for every startElement() event (even when the element is empty). All of the element's content will be reported, in order, before the corresponding endElement() event.

If the element name has a namespace prefix, the prefix will still be attached. Note that the attribute list provided will contain only attributes with explicit values (specified or defaulted): #IMPLIED attributes will be omitted.

Parameters
name:String

The element type name.

atts:AttributeList

The attributes attached to the element, if any.

Exceptions
SAXException:
Any SAX exception, possibly wrapping another exception.