org.cyberneko.pull.event
Class GeneralEntityEvent

java.lang.Object
  extended byorg.cyberneko.pull.XMLEvent
      extended byorg.cyberneko.pull.event.BoundedEvent
          extended byorg.cyberneko.pull.event.GeneralEntityEvent

public class GeneralEntityEvent
extends BoundedEvent

A general entity event. This object denotes the boundaries of general entity references (e.g. &entity;) occurring in the document instance. This does not include the five pre-defined XML entities: &, <, >, ', and ".

Version:
$Id: GeneralEntityEvent.java,v 1.4 2003/05/02 19:00:20 andyc Exp $
Author:
Andy Clark

Field Summary
 java.lang.String baseSystemId
          The base system identifier.
 java.lang.String encoding
          The auto-detected encoding of the general entity, if declared as external.
 java.lang.String expandedSystemId
          The expanded system identifier of the general entity declaration.
 java.lang.String literalSystemId
          The literal system identifier used in the general entity declaration.
 java.lang.String name
          The name of the general entity.
 java.lang.String namespace
          The namespace of the general entity.
 java.lang.String publicId
          The public identifier.
 
Fields inherited from class org.cyberneko.pull.event.BoundedEvent
start
 
Fields inherited from class org.cyberneko.pull.XMLEvent
augs, CDATA, CHARACTERS, COMMENT, DOCTYPE_DECL, DOCUMENT, ELEMENT, GENERAL_ENTITY, next, PREFIX_MAPPING, PROCESSING_INSTRUCTION, TEXT_DECL, type
 
Constructor Summary
GeneralEntityEvent()
          Default encoding.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name

public java.lang.String name
The name of the general entity.


namespace

public java.lang.String namespace
The namespace of the general entity.


publicId

public java.lang.String publicId
The public identifier. This value will be null if the general entity was declared as internal or it was declared as external using a SYSTEM reference.


baseSystemId

public java.lang.String baseSystemId
The base system identifier. This value denotes the expanded system identifier of the entity where the general entity was declared. This value will be null if the general entity was declared as internal.


literalSystemId

public java.lang.String literalSystemId
The literal system identifier used in the general entity declaration. This value will be null if the general entity was declared as internal.


expandedSystemId

public java.lang.String expandedSystemId
The expanded system identifier of the general entity declaration. This value will be null if the general entity was declared as internal.


encoding

public java.lang.String encoding
The auto-detected encoding of the general entity, if declared as external.

Constructor Detail

GeneralEntityEvent

public GeneralEntityEvent()
Default encoding.



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