|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Object | +--org.jdom.EntityRef
EntityRef Defines an XML entity reference in Java.
| Field Summary | |
protected java.lang.String |
name
The name of the EntityRef |
protected java.lang.Object |
parent
Parent element or null if none |
protected java.lang.String |
publicID
The PublicID of the EntityRef |
protected java.lang.String |
systemID
The SystemID of the EntityRef |
| Constructor Summary | |
protected |
EntityRef()
Default, no-args constructor for implementations to use if needed. |
|
EntityRef(java.lang.String name)
This will create a new EntityRef
with the supplied name. |
|
EntityRef(java.lang.String name,
java.lang.String systemID)
This will create a new EntityRef
with the supplied name and system id. |
|
EntityRef(java.lang.String name,
java.lang.String publicID,
java.lang.String systemID)
This will create a new EntityRef
with the supplied name, public id, and system id. |
| Method Summary | |
java.lang.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(java.lang.Object ob)
This tests for equality of this Entity to the supplied
Object. |
Document |
getDocument()
This retrieves the owning for
this Entity, or null if not a currently a member of a
. |
java.lang.String |
getName()
This returns the name of the EntityRef. |
Element |
getParent()
This will return the parent of this EntityRef. |
java.lang.String |
getPublicID()
This will return the publid ID of this EntityRef. |
java.lang.String |
getSystemID()
This will return the system ID of this EntityRef. |
int |
hashCode()
This returns the hash code for this Entity. |
EntityRef |
setName(java.lang.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(java.lang.String newPublicID)
This will set the public ID of this EntityRef. |
EntityRef |
setSystemID(java.lang.String newSystemID)
This will set the system ID of this EntityRef. |
java.lang.String |
toString()
This returns a String representation of the
EntityRef, suitable for debugging. |
| Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
protected java.lang.String name
EntityRef
protected java.lang.String publicID
EntityRef
protected java.lang.String systemID
EntityRef
protected java.lang.Object parent
| Constructor Detail |
protected EntityRef()
Default, no-args constructor for implementations to use if needed.
public EntityRef(java.lang.String name)
This will create a new EntityRef
with the supplied name.
name - String name of element.
IllegalNameException - if the given name is not a legal
XML name.
public EntityRef(java.lang.String name,
java.lang.String systemID)
This will create a new EntityRef
with the supplied name and system id.
name - String name of element.
IllegalNameException - if the given name is not a legal
XML name.
IllegalDataException - if the given system ID is not a legal
system literal.
public EntityRef(java.lang.String name,
java.lang.String publicID,
java.lang.String systemID)
This will create a new EntityRef
with the supplied name, public id, and system id.
name - String name of element.
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.| Method Detail |
public java.lang.Object clone()
This will return a clone of this EntityRef.
clone in class java.lang.ObjectObject - 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(java.lang.Object ob)
This tests for equality of this Entity to the supplied
Object.
equals in class java.lang.Objectob - Object to compare to.
boolean - whether the Entity is
equal to the supplied Object.public Document getDocument()
This retrieves the owning for
this Entity, or null if not a currently a member of a
Document.
Document
Document owning this Entity, or null.public java.lang.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.
EntityRefpublic java.lang.String getPublicID()
This will return the publid ID of this EntityRef.
If there is no public ID, then this returns null.
EntityRefpublic java.lang.String getSystemID()
This will return the system ID of this EntityRef.
If there is no system ID, then this returns null.
EntityRefpublic final int hashCode()
This returns the hash code for this Entity.
hashCode in class java.lang.Objectint - hash code.protected EntityRef setParent(Element parent)
This will set the parent of this Entity.
parent - Element to be new parent.
Entity modified.public EntityRef setName(java.lang.String name)
This will set the name of this EntityRef.
name - new name of the entity
EntityRef modified.
IllegalNameException - if the given name is not a legal
XML name.public EntityRef setPublicID(java.lang.String newPublicID)
This will set the public ID of this EntityRef.
newPublicID - new public id
EntityRef modified.
IllegalDataException - if the given public ID is not a legal
public ID.public EntityRef setSystemID(java.lang.String newSystemID)
This will set the system ID of this EntityRef.
newSystemID - new system id
EntityRef modified.
IllegalDataException - if the given system ID is not a legal
system literal.public java.lang.String toString()
This returns a String representation of the
EntityRef, suitable for debugging.
toString in class java.lang.ObjectString - information about the
EntityRef
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||