org.jdom

Class EntityRef

Implemented Interfaces:
Cloneable, Serializable

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.21 $, $Date: 2004/02/27 11:32:57 $
Authors:
Brett McLaughlin
Jason Hunter
Philip Nelson

Field Summary

protected String
name
The name of the EntityRef
protected String
publicID
The PublicID of the EntityRef
protected String
systemID
The SystemID of the EntityRef

Fields inherited from class org.jdom.Content

parent

Constructor Summary

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

String
getName()
This returns the name of the EntityRef.
String
getPublicID()
This will return the publid ID of this EntityRef.
String
getSystemID()
This will return the system ID of this EntityRef.
String
getValue()
Returns the empty string since entity references don't have an XPath 1.0 string value.
EntityRef
setName(String name)
This will set the name of this EntityRef.
EntityRef
setPublicID(String publicID)
This will set the public ID of this EntityRef.
EntityRef
setSystemID(String systemID)
This will set the system ID of this EntityRef.
String
toString()
This returns a String representation of the EntityRef, suitable for debugging.

Methods inherited from class org.jdom.Content

clone, detach, equals, getDocument, getParent, getParentElement, getValue, hashCode, setParent

Field Details

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 Details

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.

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

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

Method Details

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.
Overrides:
getValue in interface Content
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.

setPublicID

public EntityRef setPublicID(String publicID)
This will set the public ID of this EntityRef.
Parameters:
publicID - new public id
Returns:
this EntityRef modified.

setSystemID

public EntityRef setSystemID(String systemID)
This will set the system ID of this EntityRef.
Parameters:
systemID - new system id
Returns:
this EntityRef modified.

toString

public String toString()
This returns a String representation of the EntityRef, suitable for debugging.
Returns:
String - information about the EntityRef

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