File Doc Category Size Date Package
SerializerTrace.java API Doc Java SE 5 API 4560 Fri Aug 26 14:56:02 BST 2005 com.sun.org.apache.xml.internal.serializer

SerializerTrace

public interface SerializerTrace

This interface defines a set of integer constants that identify trace event types.

Fields Summary
public static final int
EVENTTYPE_STARTDOCUMENT
Event type generated when a document begins.
public static final int
EVENTTYPE_ENDDOCUMENT
Event type generated when a document ends.
public static final int
EVENTTYPE_STARTELEMENT
Event type generated when an element begins (after the attributes have been processed but before the children have been added).
public static final int
EVENTTYPE_ENDELEMENT
Event type generated when an element ends, after it's children have been added.
public static final int
EVENTTYPE_CHARACTERS
Event type generated for character data (CDATA and Ignorable Whitespace have their own events).
public static final int
EVENTTYPE_IGNORABLEWHITESPACE
Event type generated for ignorable whitespace (I'm not sure how much this is actually called.
public static final int
EVENTTYPE_PI
Event type generated for processing instructions.
public static final int
EVENTTYPE_COMMENT
Event type generated after a comment has been added.
public static final int
EVENTTYPE_ENTITYREF
Event type generate after an entity ref is created.
public static final int
EVENTTYPE_CDATA
Event type generated after CDATA is generated.
public static final int
EVENTTYPE_OUTPUT_PSEUDO_CHARACTERS
Event type generated when characters might be written to an output stream, but these characters never are. They will ultimately be written out via EVENTTYPE_OUTPUT_CHARACTERS. This type is used as attributes are collected. Whenever the attributes change this event type is fired. At the very end however, when the attributes do not change anymore and are going to be ouput to the document the real characters will be written out using the EVENTTYPE_OUTPUT_CHARACTERS.
public static final int
EVENTTYPE_OUTPUT_CHARACTERS
Event type generated when characters are written to an output stream.
Constructors Summary
Methods Summary
public void fireGenerateEvent(int eventType)
Fire startDocument, endDocument events.
param
eventType One of the EVENTTYPE_XXX constants.
public void fireGenerateEvent(int eventType, java.lang.String name, org.xml.sax.Attributes atts)
Fire startElement, endElement events.
param
eventType One of the EVENTTYPE_XXX constants.
param
name The name of the element.
param
atts The SAX attribute list.
public void fireGenerateEvent(int eventType, char[] ch, int start, int length)
Fire characters, cdata events.
param
eventType One of the EVENTTYPE_XXX constants.
param
ch The char array from the SAX event.
param
start The start offset to be used in the char array.
param
length The end offset to be used in the chara array.
public void fireGenerateEvent(int eventType, java.lang.String name, java.lang.String data)
Fire processingInstruction events.
param
eventType One of the EVENTTYPE_XXX constants.
param
name The name of the processing instruction.
param
data The processing instruction data.
public void fireGenerateEvent(int eventType, java.lang.String data)
Fire comment and entity ref events.
param
eventType One of the EVENTTYPE_XXX constants.
param
data The comment or entity ref data.
public boolean hasTraceListeners()
Tell if trace listeners are present.
return
True if there are trace listeners