com.xmlmind.xml.load

Class Entities

java.lang.Object

com.xmlmind.xml.load.Entities

public final class Entities
extends Object

Models the set of entities as found in a DTD. This set contains only general entities, not parameter entities.

See Also:

DTDSpec

Constructor Summary

Constructors

Constructor and Description
Entities()

Method Summary

Modifier and Type	Method and Description
ExternalEntityDecl	externalEntityDecl(String name, String publicId, String systemId, URL baseURL, String origin) Adds specified external entity declaration to this set.
EntityDecl	get(String name) Returns the general or unparsed entity having specified name if found in this set; null otherwise.
EntityDecl[]	getAll() Returns the (possibly empty) array containing all the declaration of this set.
CharEntities	getCharEntities() Returns the set of character entities included in this set.
InternalEntityDecl	internalEntityDecl(String name, String value, String origin) Adds specified internal entity declaration to this set.
UnparsedEntityDecl	unparsedEntityDecl(String name, String publicId, String systemId, URL baseURL, String notationName, String origin) Adds specified unparsed entity declaration to this set.

Methods inherited from class java.lang.Object

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

Constructor Detail

Entities

public Entities()

Method Detail

internalEntityDecl

public InternalEntityDecl internalEntityDecl(String name,
                                             String value,
                                             String origin)

Adds specified internal entity declaration to this set. The declaration of a general entity is added to the set. The declaration of a parameter entity is just created and returned.

Parameters:

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

value - The value of the entity.

origin - Not for public use: a string identifying the source where this declaration is found.

Returns:

newly created declaration

externalEntityDecl

public ExternalEntityDecl externalEntityDecl(String name,
                                             String publicId,
                                             String systemId,
                                             URL baseURL,
                                             String origin)

Adds specified external entity declaration to this set. The declaration of a general entity is added to the set. The declaration of a parameter entity is just created and returned.

Parameters:

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

publicId - The public ID of the external entity, if any. May be null.

systemId - The system ID of the external entity.

baseURL - The URL against which a relative system ID of the external entity should be resolved.

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

Returns:

newly created declaration

unparsedEntityDecl

public UnparsedEntityDecl unparsedEntityDecl(String name,
                                             String publicId,
                                             String systemId,
                                             URL baseURL,
                                             String notationName,
                                             String origin)

Adds specified unparsed entity declaration to this set.

Parameters:

name - The name of the entity.

publicId - The public ID of the unparsed entity, if any. May be null.

systemId - The system ID of the unparsed entity.

baseURL - The URL against which a relative system ID of the unparsed entity should be resolved.

notationName - The name of the notation associated to the unparsed entity.

origin - Not for public use: a string identifying the source where this declaration is found.

Returns:

newly created declaration

getAll

public EntityDecl[] getAll()

Returns the (possibly empty) array containing all the declaration of this set.

get

public EntityDecl get(String name)

Returns the general or unparsed entity having specified name if found in this set; null otherwise.

getCharEntities

public CharEntities getCharEntities()

Returns the set of character entities included in this set. A character entity is an internal, general, entity having a 1-character long value.