com.xmlmind.xml.load

Class EntityDecl

java.lang.Object

com.xmlmind.xml.load.Decl

com.xmlmind.xml.load.EntityDecl

Direct Known Subclasses:

ExternalEntityDecl, InternalEntityDecl

public abstract class EntityDecl
extends Decl

The base class of all entities: general or parameter, internal or external, parsed or unparsed.

Nested Class Summary

Nested classes/interfaces inherited from class com.xmlmind.xml.load.Decl

Decl.Type

Field Summary

Fields

Modifier and Type	Field and Description
String	name The name of the entity.
String	origin Not for public use: a string identifying the source where the entity declaration is found.

Fields inherited from class com.xmlmind.xml.load.Decl

declType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EntityDecl(Decl.Type declType, String name, String origin)

Method Summary

Modifier and Type	Method and Description
URL	getURL() Returns the fully resolved, possibly using XML catalogs, URL of this entity.
boolean	isCharEntity() Returns true if this is a character entity (internal, general entity, having a one character long value); false otherwise.
boolean	isParameterEntity() Returns true if this is a parameter entity; false if it is a general entity.

Methods inherited from class com.xmlmind.xml.load.Decl

appendExternalId, appendValue, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

public final String name

The name of the entity. Starts with '%' if it is a parameter entity.

origin

public final String origin

Not for public use: a string identifying the source where the entity declaration is found.

Constructor Detail

EntityDecl

protected EntityDecl(Decl.Type declType,
                     String name,
                     String origin)

Method Detail

isParameterEntity

public boolean isParameterEntity()

Returns true if this is a parameter entity; false if it is a general entity.

isCharEntity

public boolean isCharEntity()

Returns true if this is a character entity (internal, general entity, having a one character long value); false otherwise.

getURL

public URL getURL()

Returns the fully resolved, possibly using XML catalogs, URL of this entity. Returns null if there is no such URL (e.g. internal entity) or if the URL is unknown or malformed.