org.jdom
public class EntityRef extends Object implements Serializable, Cloneable
EntityRef
Defines an XML entity reference in Java.
Version: $Revision: 1.8 $, $Date: 2002/03/12 07:11:39 $
Field Summary | |
---|---|
protected String | name The name of the EntityRef |
protected Object | parent Parent element or null if none |
protected String | publicID The PublicID of the EntityRef |
protected String | systemID 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(String name, String systemID)
This will create a new | |
EntityRef(String name, String publicID, String systemID)
This will create a new |
Method Summary | |
---|---|
Object | clone()
This will return a clone of this |
EntityRef | detach()
This detaches the |
boolean | equals(Object ob)
This tests for equality of this |
Document | getDocument() |
String | getName()
This returns the name of the
|
Element | getParent()
This will return the parent of this |
String | getPublicID()
This will return the publid ID of this |
String | getSystemID()
This will return the system ID of this |
int | hashCode()
This returns the hash code for this |
EntityRef | setName(String name)
This will set the name of this |
protected EntityRef | setParent(Element parent)
This will set the parent of this |
EntityRef | setPublicID(String newPublicID)
This will set the public ID of this |
EntityRef | setSystemID(String newSystemID)
This will set the system ID of this |
String | toString()
This returns a |
EntityRef
EntityRef
EntityRef
Default, no-args constructor for implementations to use if needed.
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.
This will create a new EntityRef
with the supplied name and system id.
Parameters: name String
name of element.
Throws: IllegalNameException if the given name is not a legal XML name. IllegalDataException if the given system ID is not a legal system literal.
This will create a new EntityRef
with the supplied name, public id, and system id.
Parameters: name String
name of element.
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.
This will return a clone of this EntityRef
.
Returns: Object
- clone of this EntityRef
.
This detaches the Entity
from its parent, or does nothing
if the Entity
has no parent.
Returns: Entity
- this Entity
modified.
This tests for equality of this Entity
to the supplied
Object
.
Parameters: ob Object
to compare to.
Returns: boolean
- whether the Entity
is
equal to the supplied Object
.
This retrieves the owning Document
for
this Entity, or null if not a currently a member of a
Document
.
Returns: Document
owning this Entity, or null.
This returns the name of the
EntityRef
.
Returns: String
- entity name.
This will return the parent of this EntityRef
.
If there is no parent, then this returns null
.
Returns: parent of this EntityRef
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
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
This returns the hash code for this Entity
.
Returns: int
- hash code.
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.
This will set the parent of this Entity
.
Parameters: parent Element
to be new parent.
Returns: this Entity
modified.
This will set the public ID of this EntityRef
.
Parameters: newPublicID new public id
Returns: this EntityRef
modified.
Throws: IllegalDataException if the given public ID is not a legal public ID.
This will set the system ID of this EntityRef
.
Parameters: newSystemID new system id
Returns: this EntityRef
modified.
Throws: IllegalDataException if the given system ID is not a legal system literal.
This returns a String
representation of the
EntityRef
, suitable for debugging.
Returns: String
- information about the
EntityRef