Package org.jdom
Class EntityRef
java.lang.Object
org.jdom.Content
org.jdom.EntityRef
- All Implemented Interfaces:
Serializable
,Cloneable
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
- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Default, no-args constructor for implementations to use if needed.This will create a newEntityRef
with the supplied name.This will create a newEntityRef
with the supplied name and system id.This will create a newEntityRef
with the supplied name, public id, and system id. -
Method Summary
Modifier and TypeMethodDescriptiongetName()
This returns the name of theEntityRef
.This will return the publid ID of thisEntityRef
.This will return the system ID of thisEntityRef
.getValue()
Returns the empty string since entity references don't have an XPath 1.0 string value.This will set the name of thisEntityRef
.setPublicID
(String publicID) This will set the public ID of thisEntityRef
.setSystemID
(String systemID) This will set the system ID of thisEntityRef
.toString()
This returns aString
representation of theEntityRef
, suitable for debugging.Methods inherited from class org.jdom.Content
clone, detach, equals, getDocument, getParent, getParentElement, hashCode, setParent
-
Field Details
-
name
The name of theEntityRef
-
publicID
The PublicID of theEntityRef
-
systemID
The SystemID of theEntityRef
-
-
Constructor Details
-
EntityRef
protected EntityRef()Default, no-args constructor for implementations to use if needed. -
EntityRef
This will create a newEntityRef
with the supplied name.- Parameters:
name
-String
name of element.- Throws:
IllegalNameException
- if the given name is not a legal XML name.
-
EntityRef
This will create a newEntityRef
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
This will create a newEntityRef
with the supplied name, public id, and system id.- Parameters:
name
-String
name of element.publicID
- public id of the entity reference being constructedsystemID
- 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 IDIllegalNameException
- if the given name is not a legal XML name.
-
-
Method Details
-
getName
This returns the name of theEntityRef
.- Returns:
String
- entity name.
-
getValue
Returns the empty string since entity references don't have an XPath 1.0 string value. -
getPublicID
This will return the publid ID of thisEntityRef
. If there is no public ID, then this returnsnull
.- Returns:
- public ID of this
EntityRef
-
getSystemID
This will return the system ID of thisEntityRef
. If there is no system ID, then this returnsnull
.- Returns:
- system ID of this
EntityRef
-
setName
This will set the name of thisEntityRef
.- Parameters:
name
- new name of the entity- Returns:
- this
EntityRef
modified. - Throws:
IllegalNameException
- if the given name is not a legal XML name.
-
setPublicID
This will set the public ID of thisEntityRef
.- Parameters:
publicID
- new public id- Returns:
- this
EntityRef
modified. - Throws:
IllegalDataException
- if the given public ID is not a legal public ID.
-
setSystemID
This will set the system ID of thisEntityRef
.- Parameters:
systemID
- new system id- Returns:
- this
EntityRef
modified. - Throws:
IllegalDataException
- if the given system ID is not a legal system literal.
-
toString
This returns aString
representation of theEntityRef
, suitable for debugging.
-