All Packages Class Hierarchy This Package Previous Next Index
java.lang.Object | +----org.jdom.EntityRef
EntityRef
Defines an XML entity reference in Java.
EntityRef
EntityRef
EntityRef
Default, no-args constructor for implementations to use if needed.
This will create a new EntityRef
with the supplied name.
This will create a new EntityRef
with the supplied name and system id.
This will create a new EntityRef
with the supplied name, public id, and system id.
This will return a clone of this EntityRef
.
This detaches the Entity
from its parent, or does nothing
if the Entity
has no parent.
This tests for equality of this Entity
to the supplied
Object
.
This retrieves the owning
This returns the name of the
This will return the parent of this
This will return the publid ID of this
This will return the system ID of this
This returns the hash code for this
This will set the name of this
This will set the parent of this
This will set the public ID of this
This will set the system ID of this
This returns a {
getName()
EntityRef
.
getParent()
EntityRef
.
getPublicID()
EntityRef
.
getSystemID()
EntityRef
.
hashCode()
Entity
.
setName(String)
EntityRef
.
setParent(Element)
Entity
.
setPublicID(String)
EntityRef
.
setSystemID(String)
EntityRef
.
toString()
String
representation of the
EntityRef
, suitable for debugging.
protected String name
EntityRef
protected String publicID
EntityRef
protected String systemID
EntityRef
protected Object parent
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.
String
name of element.
public EntityRef(String name, String systemID)
This will create a new EntityRef
with the supplied name and system id.
String
name of element.
public EntityRef(String name, String publicID, String systemID)
This will create a new EntityRef
with the supplied name, public id, and system id.
String
name of element.
public Object clone()
This will return a clone of this EntityRef
.
Object
- clone of this EntityRef
.
public EntityRef detach()
This detaches the Entity
from its parent, or does nothing
if the Entity
has no parent.
Entity
- this Entity
modified.
public final boolean equals(Object ob)
This tests for equality of this Entity
to the supplied
Object
.
Object
to compare to.
boolean
- whether the Entity
is
equal to the supplied Object
.
public Document getDocument()
This retrieves the owning {@link Document}
for
this Entity, or null if not a currently a member of a
{@link Document}
.
Document
owning this Entity, or null.
public String getName()
This returns the name of the
EntityRef
.
String
- entity name.
public Element getParent()
This will return the parent of this EntityRef
.
If there is no parent, then this returns null
.
EntityRef
public String getPublicID()
This will return the publid ID of this EntityRef
.
If there is no public ID, then this returns null
.
EntityRef
public String getSystemID()
This will return the system ID of this EntityRef
.
If there is no system ID, then this returns null
.
EntityRef
public final int hashCode()
This returns the hash code for this Entity
.
int
- hash code.
protected EntityRef setParent(Element parent)
This will set the parent of this Entity
.
Element
to be new parent.
Entity
modified.
public EntityRef setName(String name)
This will set the name of this EntityRef
.
EntityRef
modified.
public EntityRef setPublicID(String newPublicID)
This will set the public ID of this EntityRef
.
EntityRef
modified.
public EntityRef setSystemID(String newSystemID)
This will set the system ID of this EntityRef
.
EntityRef
modified.
public String toString()
This returns a String
representation of the
EntityRef
, suitable for debugging.
String
- information about the
EntityRef
All Packages Class Hierarchy This Package Previous Next Index