| java.lang.Object
 org.jdom.Content
org.jdom.EntityRef
| EntityRef | | public class EntityRef extends Content (Code) | | An XML entity reference. Methods allow the user to manage its name, public
id, and system id.
version:
$Revision: 1.1 $, $Date: 2005/04/27 09:32:38 $
author:
Brett McLaughlin
author:
Jason Hunter
author:
Philip Nelson |
| Constructor Summary | |
| protected | EntityRef()
Default, no-args constructor for implementations to use if needed. | | public | EntityRef(String name)
This will create a new EntityRef with the supplied name. | | public | EntityRef(String name, String systemID)
This will create a new EntityRef
with the supplied name and system id. | | public | EntityRef(String name, String publicID, String systemID)
This will create a new EntityRef
with the supplied name, public id, and system id. |
| publicID | | protected String publicID(Code) | | The PublicID of the EntityRef
|
| systemID | | protected String systemID(Code) | | The SystemID of the EntityRef
|
| EntityRef | | protected EntityRef()(Code) | | Default, no-args constructor for implementations to use if needed.
|
| EntityRef | | public EntityRef(String name)(Code) | | 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 legalXML name. |
| EntityRef | | public EntityRef(String name, String systemID)(Code) | | This will create a new EntityRef
with the supplied name and system id.
Parameters:
name - String name of element.
Parameters:
systemID - system id of the entity reference being constructed
throws:
IllegalNameException - if the given name is not a legalXML name.
throws:
IllegalDataException - if the given system ID is not a legalsystem literal. |
| EntityRef | | public EntityRef(String name, String publicID, String systemID)(Code) | | This will create a new EntityRef
with the supplied name, public id, and system id.
Parameters:
name - String name of element.
Parameters:
publicID - public id of the entity reference being constructed
Parameters:
systemID - system id of the entity reference being constructed
throws:
IllegalDataException - if the given system ID is not a legalsystem literal or the the given public ID is not alegal public ID
throws:
IllegalNameException - if the given name is not a legalXML name. |
| getName | | public String getName()(Code) | | This returns the name of the EntityRef.
String - entity name. |
| getPublicID | | public String getPublicID()(Code) | | This will return the publid ID of this EntityRef.
If there is no public ID, then this returns null.
public ID of this EntityRef |
| getSystemID | | public String getSystemID()(Code) | | This will return the system ID of this EntityRef.
If there is no system ID, then this returns null.
system ID of this EntityRef |
| getValue | | public String getValue()(Code) | | Returns the empty string since entity references don't have an XPath
1.0 string value.
the empty string |
| setName | | public EntityRef setName(String name)(Code) | | This will set the name of this EntityRef.
Parameters:
name - new name of the entity this EntityRef modified.
throws:
IllegalNameException - if the given name is not a legalXML name. |
| setPublicID | | public EntityRef setPublicID(String publicID)(Code) | | This will set the public ID of this EntityRef.
Parameters:
publicID - new public id this EntityRef modified.
throws:
IllegalDataException - if the given public ID is not a legalpublic ID. |
| setSystemID | | public EntityRef setSystemID(String systemID)(Code) | | This will set the system ID of this EntityRef.
Parameters:
systemID - new system id
throws:
IllegalDataException - if the given system ID is not a legalsystem literal. this EntityRef modified. |
| toString | | public String toString()(Code) | | This returns a String representation of the
EntityRef, suitable for debugging.
String - information about theEntityRef |
|
|