BEA Systems, Inc.

WebLogic Server 8.1 API Reference

weblogic.xml.stream
Interface XMLEvent

All Known Subinterfaces:
ChangePrefixMapping, CharacterData, Comment, EndDocument, EndElement, EndPrefixMapping, EntityReference, ProcessingInstruction, Space, StartDocument, StartElement, StartPrefixMapping

public interface XMLEvent

This is the base element interface for handling markup events.

Author:
Copyright © 2004 BEA Systems, Inc. All Rights Reserved.
See Also:
CharacterData, ProcessingInstruction, StartElement, EndElement, CharacterData, XMLName, StartDocument

Field Summary
static int CHANGE_PREFIX_MAPPING
          A constant which identifies a ChangePrefixMapping
static int CHARACTER_DATA
          A constant which identifies a CharacterData Event
static int COMMENT
          A constant which identifies a Comment
static int END_DOCUMENT
          A constant which identifies an EndDocument
static int END_ELEMENT
          A constant which identifies an EndElement
static int END_PREFIX_MAPPING
          A constant which identifies a EndPrefixMapping
static int ENTITY_REFERENCE
          A constant which identifies an EntityReference
static int NULL_ELEMENT
          A constant which identifies a NullElement
static int PROCESSING_INSTRUCTION
          A constant which identifies a ProcessingInstruction
static int SPACE
          A constant which identifies a Space
static int START_DOCUMENT
          A constant which identifies a StartDocument
static int START_ELEMENT
          A constant which identifies a StartElement
static int START_PREFIX_MAPPING
          A constant which identifies a StartPrefixMapping
static int XML_EVENT
          A constant which identifies an XMLEvent
 
Method Summary
 Location getLocation()
          Return the location of this Element
 XMLName getName()
          Get the XMLName of the current element
 XMLName getSchemaType()
          Get the event type of the current element, returns an integer so that switch statements can be written on the result
 int getType()
          Get the event type of the current element, returns an integer so that switch statements can be written on the result
 java.lang.String getTypeAsString()
          Get the string value of the type name
 boolean hasName()
          Check if this Element has a name
 boolean isChangePrefixMapping()
           
 boolean isCharacterData()
           
 boolean isEndDocument()
           
 boolean isEndElement()
           
 boolean isEndPrefixMapping()
           
 boolean isEntityReference()
           
 boolean isNull()
           
 boolean isProcessingInstruction()
           
 boolean isSpace()
           
 boolean isStartDocument()
           
 boolean isStartElement()
          Method access to the elements type
 boolean isStartPrefixMapping()
           
 

Field Detail

XML_EVENT

public static final int XML_EVENT
A constant which identifies an XMLEvent
See Also:
XMLEvent

START_ELEMENT

public static final int START_ELEMENT
A constant which identifies a StartElement
See Also:
StartElement

END_ELEMENT

public static final int END_ELEMENT
A constant which identifies an EndElement
See Also:
EndElement

PROCESSING_INSTRUCTION

public static final int PROCESSING_INSTRUCTION
A constant which identifies a ProcessingInstruction
See Also:
ProcessingInstruction

CHARACTER_DATA

public static final int CHARACTER_DATA
A constant which identifies a CharacterData Event
See Also:
CharacterData

COMMENT

public static final int COMMENT
A constant which identifies a Comment
See Also:
Comment

SPACE

public static final int SPACE
A constant which identifies a Space
See Also:
Space

NULL_ELEMENT

public static final int NULL_ELEMENT
A constant which identifies a NullElement

START_DOCUMENT

public static final int START_DOCUMENT
A constant which identifies a StartDocument
See Also:
StartDocument

END_DOCUMENT

public static final int END_DOCUMENT
A constant which identifies an EndDocument
See Also:
EndDocument

START_PREFIX_MAPPING

public static final int START_PREFIX_MAPPING
A constant which identifies a StartPrefixMapping
See Also:
StartPrefixMapping

END_PREFIX_MAPPING

public static final int END_PREFIX_MAPPING
A constant which identifies a EndPrefixMapping
See Also:
EndPrefixMapping

CHANGE_PREFIX_MAPPING

public static final int CHANGE_PREFIX_MAPPING
A constant which identifies a ChangePrefixMapping
See Also:
ChangePrefixMapping

ENTITY_REFERENCE

public static final int ENTITY_REFERENCE
A constant which identifies an EntityReference
See Also:
EntityReference
Method Detail

getType

public int getType()
Get the event type of the current element, returns an integer so that switch statements can be written on the result

getSchemaType

public XMLName getSchemaType()
Get the event type of the current element, returns an integer so that switch statements can be written on the result

getTypeAsString

public java.lang.String getTypeAsString()
Get the string value of the type name

getName

public XMLName getName()
Get the XMLName of the current element

See Also:
XMLName

hasName

public boolean hasName()
Check if this Element has a name

getLocation

public Location getLocation()
Return the location of this Element

isStartElement

public boolean isStartElement()
Method access to the elements type

isEndElement

public boolean isEndElement()

isEntityReference

public boolean isEntityReference()

isStartPrefixMapping

public boolean isStartPrefixMapping()

isEndPrefixMapping

public boolean isEndPrefixMapping()

isChangePrefixMapping

public boolean isChangePrefixMapping()

isProcessingInstruction

public boolean isProcessingInstruction()

isCharacterData

public boolean isCharacterData()

isSpace

public boolean isSpace()

isNull

public boolean isNull()

isStartDocument

public boolean isStartDocument()

isEndDocument

public boolean isEndDocument()

Documentation is available at
http://download.oracle.com/docs/cd/E13222_01/wls/docs81