com.conradroche.dtd.decl
Interface Entity

All Superinterfaces:

ExternalID

All Known Subinterfaces:

GeneralEntity, ParameterEntity

All Known Implementing Classes:

Entity

public interface Entity

extends ExternalID

Interface defining the Entity Declaration.

Author:

Conrad Roche

Method Summary

String	getEntityName() Returns the name of this entity.
String	getLiteralValue() Returns the literal value of this Entity.
String	getReplacementText() Returns the replacement text for this Entity.
boolean	isExternalEntity() Returns true if this entity is an external entity; false otherwise.
boolean	isGeneralEntity() Returns true if the Entity is a General Entity and false otherwise.
boolean	isInternalEntity() Returns true if this entity is an internal entity; false otherwise.
boolean	isParameterEntity() Returns true if the Entity is a Parameter Entity and false otherwise.
boolean	isParsedEntity() Returns true if this entity is an parsed entity; false otherwise.
boolean	isUnparsedEntity() Returns true if this entity is an parsed entity; false otherwise.
void	setEntityName(String name) Sets the name for this entity.
void	setLiteralValue(String value) Sets the literal value of this Entity.

Methods inherited from interface com.conradroche.dtd.decl.ExternalID

getPublicIdentifier, getSystemIdentifier, hasPublicIdentifier, hasSystemIdentifier, setPublicIdentifier, setSystemIdentifier

Method Detail

getEntityName

public String getEntityName()

Returns the name of this entity.

Returns:

The Entity name.

See Also:

setEntityName(java.lang.String)

setEntityName

public void setEntityName(String name)

Sets the name for this entity.

Parameters:

name - The Entity name.

See Also:

getEntityName()

getLiteralValue

public String getLiteralValue()

Returns the literal value of this Entity.

Returns:

The Entity's literal value.

See Also:

setLiteralValue(java.lang.String)

setLiteralValue

public void setLiteralValue(String value)

Sets the literal value of this Entity.

Parameters:

value - The Entity's literal value.

See Also:

getLiteralValue()

getReplacementText

public String getReplacementText()

Returns the replacement text for this Entity.
From the XML 1.0 Specification - [Definition: The replacement text is the content of the entity, after replacement of character references and parameter-entity references.]

Returns:

The replacement text.

isInternalEntity

public boolean isInternalEntity()

Returns true if this entity is an internal entity; false otherwise.
From the XML 1.0 Specifications - [Definition: If the entity definition is an EntityValue, the defined entity is called an internal entity. There is no separate physical storage object, and the content of the entity is given in the declaration.] Note that some processing of entity and character references in the literal entity literalValue may be required to produce the correct replacement text

Returns:

true if this entity is an internal entity; false otherwise.

isExternalEntity

public boolean isExternalEntity()

Returns true if this entity is an external entity; false otherwise.
From the XML 1.0 Specifications - Definition: If the entity is not internal, it is an external entity

Returns:

true if this entity is an external entity; false otherwise.

isParsedEntity

public boolean isParsedEntity()

Returns true if this entity is an parsed entity; false otherwise.
From XML 1.0 Specifications - [Definition: A parsed entity's contents are referred to as its replacement text; this text is considered an integral part of the document.]

Returns:

true if this entity is an parsed entity; false otherwise.

isUnparsedEntity

public boolean isUnparsedEntity()

Returns true if this entity is an parsed entity; false otherwise.
From XML 1.0 Specifications - [Definition: An unparsed entity is a resource whose contents may or may not be text, and if text, may be other than XML. Each unparsed entity has an associated notation, identified by name. Beyond a requirement that an XML processor make the identifiers for the entity and notation available to the application, XML places no constraints on the contents of unparsed entities.]

Returns:

true if this entity is an parsed entity; false otherwise.

isGeneralEntity

public boolean isGeneralEntity()

Returns true if the Entity is a General Entity and false otherwise.

Returns:

true for General Entity and false otherwise.

isParameterEntity

public boolean isParameterEntity()

Returns true if the Entity is a Parameter Entity and false otherwise.

Returns:

true for Parameter Entity and false otherwise.