org.cyberneko.pull
Class XMLEvent

java.lang.Object
  extended byorg.cyberneko.pull.XMLEvent
Direct Known Subclasses:
BoundedEvent, CharactersEvent, CommentEvent, DoctypeDeclEvent, ProcessingInstructionEvent, TextDeclEvent

public class XMLEvent
extends java.lang.Object

The base XML event class. For a complete list of available events, refer to the org.cyberneko.pull.event package.

Version:
$Id: XMLEvent.java,v 1.2 2003/01/28 20:00:30 andyc Exp $
Author:
Andy Clark

Field Summary
 org.apache.xerces.xni.Augmentations augs
          Event augmentations.
static short CDATA
          Event type: CDATA section.
static short CHARACTERS
          Event type: character content.
static short COMMENT
          Event type: comment.
static short DOCTYPE_DECL
          Event type: DOCTYPE declaration.
static short DOCUMENT
          Event type: document.
static short ELEMENT
          Event type: element.
static short GENERAL_ENTITY
          Event type: general entity.
 XMLEvent next
          Next event, if used in an event chain.
static short PREFIX_MAPPING
          Event type: prefix mapping.
static short PROCESSING_INSTRUCTION
          Event type: processing instruction.
static short TEXT_DECL
          Event type: text declaration.
 short type
          Event type.
 
Constructor Summary
XMLEvent(short type)
          Constructs an XML event with the specified type.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DOCUMENT

public static final short DOCUMENT
Event type: document.

See Also:
Constant Field Values

ELEMENT

public static final short ELEMENT
Event type: element.

See Also:
Constant Field Values

CHARACTERS

public static final short CHARACTERS
Event type: character content.

See Also:
Constant Field Values

PREFIX_MAPPING

public static final short PREFIX_MAPPING
Event type: prefix mapping.

See Also:
Constant Field Values

GENERAL_ENTITY

public static final short GENERAL_ENTITY
Event type: general entity.

See Also:
Constant Field Values

COMMENT

public static final short COMMENT
Event type: comment.

See Also:
Constant Field Values

PROCESSING_INSTRUCTION

public static final short PROCESSING_INSTRUCTION
Event type: processing instruction.

See Also:
Constant Field Values

CDATA

public static final short CDATA
Event type: CDATA section.

See Also:
Constant Field Values

TEXT_DECL

public static final short TEXT_DECL
Event type: text declaration.

See Also:
Constant Field Values

DOCTYPE_DECL

public static final short DOCTYPE_DECL
Event type: DOCTYPE declaration.

See Also:
Constant Field Values

type

public final short type
Event type. This field is final and must be set within the constructor of any subclass.


augs

public org.apache.xerces.xni.Augmentations augs
Event augmentations.


next

public XMLEvent next
Next event, if used in an event chain. Typically, only a single event is returned at a time. However, this field is present to enable higher-level constructs to chain events together. For example, this can be useful to avoid concatenating the contents of character buffers, etc.

Constructor Detail

XMLEvent

public XMLEvent(short type)
Constructs an XML event with the specified type.



(C) Copyright 2002-2004, Andy Clark. All rights reserved.