org.jdom

Class EntityRef

public class EntityRef extends Content

An XML entity reference. Methods allow the user to manage its name, public id, and system id.

Version: $Revision: 1.22 $, $Date: 2007/11/10 05:28:59 $

Author: Brett McLaughlin Jason Hunter Philip Nelson

Field Summary
protected Stringname
The name of the EntityRef
protected StringpublicID
The PublicID of the EntityRef
protected StringsystemID
The SystemID of the EntityRef
Constructor Summary
protected EntityRef()
Default, no-args constructor for implementations to use if needed.
EntityRef(String name)
This will create a new EntityRef with the supplied name.
EntityRef(String name, String systemID)
This will create a new EntityRef with the supplied name and system id.
EntityRef(String name, String publicID, String systemID)
This will create a new EntityRef with the supplied name, public id, and system id.
Method Summary
StringgetName()
This returns the name of the EntityRef.
StringgetPublicID()
This will return the publid ID of this EntityRef.
StringgetSystemID()
This will return the system ID of this EntityRef.
StringgetValue()
Returns the empty string since entity references don't have an XPath 1.0 string value.
EntityRefsetName(String name)
This will set the name of this EntityRef.
EntityRefsetPublicID(String publicID)
This will set the public ID of this EntityRef.
EntityRefsetSystemID(String systemID)
This will set the system ID of this EntityRef.
StringtoString()
This returns a String representation of the EntityRef, suitable for debugging.

Field Detail

name

protected String name
The name of the EntityRef

publicID

protected String publicID
The PublicID of the EntityRef

systemID

protected String systemID
The SystemID of the EntityRef

Constructor Detail

EntityRef

protected EntityRef()
Default, no-args constructor for implementations to use if needed.

EntityRef

public EntityRef(String name)
This will create a new EntityRef with the supplied name.

Parameters: name String name of element.

Throws: IllegalNameException if the given name is not a legal XML name.

EntityRef

public EntityRef(String name, String systemID)
This will create a new EntityRef with the supplied name and system id.

Parameters: name String name of element. systemID system id of the entity reference being constructed

Throws: IllegalNameException if the given name is not a legal XML name. IllegalDataException if the given system ID is not a legal system literal.

EntityRef

public EntityRef(String name, String publicID, String systemID)
This will create a new EntityRef with the supplied name, public id, and system id.

Parameters: name String name of element. publicID public id of the entity reference being constructed systemID system id of the entity reference being constructed

Throws: IllegalDataException if the given system ID is not a legal system literal or the the given public ID is not a legal public ID IllegalNameException if the given name is not a legal XML name.

Method Detail

getName

public String getName()
This returns the name of the EntityRef.

Returns: String - entity name.

getPublicID

public String getPublicID()
This will return the publid ID of this EntityRef. If there is no public ID, then this returns null.

Returns: public ID of this EntityRef

getSystemID

public String getSystemID()
This will return the system ID of this EntityRef. If there is no system ID, then this returns null.

Returns: system ID of this EntityRef

getValue

public String getValue()
Returns the empty string since entity references don't have an XPath 1.0 string value.

Returns: the empty string

setName

public EntityRef setName(String name)
This will set the name of this EntityRef.

Parameters: name new name of the entity

Returns: this EntityRef modified.

Throws: IllegalNameException if the given name is not a legal XML name.

setPublicID

public EntityRef setPublicID(String publicID)
This will set the public ID of this EntityRef.

Parameters: publicID new public id

Returns: this EntityRef modified.

Throws: IllegalDataException if the given public ID is not a legal public ID.

setSystemID

public EntityRef setSystemID(String systemID)
This will set the system ID of this EntityRef.

Parameters: systemID new system id

Returns: this EntityRef modified.

Throws: IllegalDataException if the given system ID is not a legal system literal.

toString

public String toString()
This returns a String representation of the EntityRef, suitable for debugging.

Returns: String - information about the EntityRef

Copyright B) 2007 Jason Hunter, Brett McLaughlin. All Rights Reserved.