org.jdom
Class EntityRef
- Cloneable, Serializable
public class EntityRef
extends java.lang.Object
implements Serializable, Cloneable
EntityRef
Defines an XML entity reference in Java.
$Revision: 1.8 $, $Date: 2002/03/12 07:11:39 $- Brett McLaughlin
- Jason Hunter
- Philip Nelson
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
|
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.
|
Object | clone() -
This will return a clone of this
EntityRef .
|
EntityRef | detach() -
This detaches the
Entity from its parent, or does nothing
if the Entity has no parent.
|
boolean | equals(Object ob) -
This tests for equality of this
Entity to the supplied
Object .
|
Document | getDocument() -
This retrieves the owning
Document for
this Entity, or null if not a currently a member of a
Document .
|
String | getName() -
This returns the name of the
EntityRef .
|
Element | getParent() -
This will return the parent of this
EntityRef .
|
String | getPublicID() -
This will return the publid ID of this
EntityRef .
|
String | getSystemID() -
This will return the system ID of this
EntityRef .
|
int | hashCode() -
This returns the hash code for this
Entity .
|
EntityRef | setName(String name) -
This will set the name of this
EntityRef .
|
protected EntityRef | setParent(Element parent) -
This will set the parent of this
Entity .
|
EntityRef | setPublicID(String newPublicID) -
This will set the public ID of this
EntityRef .
|
EntityRef | setSystemID(String newSystemID) -
This will set the system ID of this
EntityRef .
|
String | toString() -
This returns a
String representation of the
EntityRef , suitable for debugging.
|
name
protected String name
The name of the EntityRef
parent
protected Object parent
Parent element or null if none
publicID
protected String publicID
The PublicID of the EntityRef
systemID
protected String systemID
The SystemID of the EntityRef
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.
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.
name
- String
name of element.
EntityRef
public EntityRef(String name,
String publicID,
String systemID)
This will create a new EntityRef
with the supplied name, public id, and system id.
name
- String
name of element.
clone
public Object clone()
This will return a clone of this EntityRef
.
Object
- clone of this EntityRef
.
detach
public EntityRef detach()
This detaches the Entity
from its parent, or does nothing
if the Entity
has no parent.
Entity
- this Entity
modified.
equals
public final boolean equals(Object ob)
This tests for equality of this Entity
to the supplied
Object
.
ob
- Object
to compare to.
boolean
- whether the Entity
is
equal to the supplied Object
.
getDocument
public Document getDocument()
This retrieves the owning
Document
for
this Entity, or null if not a currently a member of a
Document
.
Document
owning this Entity, or null.
getName
public String getName()
This returns the name of the
EntityRef
.
getParent
public Element getParent()
This will return the parent of this EntityRef
.
If there is no parent, then this returns null
.
getPublicID
public String getPublicID()
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()
This will return the system ID of this EntityRef
.
If there is no system ID, then this returns null
.
- system ID of this
EntityRef
hashCode
public final int hashCode()
This returns the hash code for this Entity
.
setName
public EntityRef setName(String name)
This will set the name of this EntityRef
.
name
- new name of the entity
setParent
protected EntityRef setParent(Element parent)
This will set the parent of this Entity
.
parent
- Element
to be new parent.
setPublicID
public EntityRef setPublicID(String newPublicID)
This will set the public ID of this EntityRef
.
newPublicID
- new public id
setSystemID
public EntityRef setSystemID(String newSystemID)
This will set the system ID of this EntityRef
.
newSystemID
- new system id
toString
public String toString()
This returns a String
representation of the
EntityRef
, suitable for debugging.
String
- information about the
EntityRef
Copyright B) 2002 Jason Hunter, Brett McLaughlin. All Rights Reserved.