|
JDOM 1.1.3 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.jdom.Content
org.jdom.EntityRef
public class EntityRef
An XML entity reference. Methods allow the user to manage its name, public id, and system id.
| Field Summary | |
|---|---|
protected java.lang.String |
name
The name of the EntityRef |
protected java.lang.String |
publicID
The PublicID of the EntityRef |
protected java.lang.String |
systemID
The SystemID of the EntityRef |
| Fields inherited from class org.jdom.Content |
|---|
parent |
| 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.String |
getName()
This returns the name of the 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. |
java.lang.String |
getValue()
Returns the empty string since entity references don't have an XPath 1.0 string value. |
EntityRef |
setName(java.lang.String name)
This will set the name of this EntityRef. |
EntityRef |
setPublicID(java.lang.String publicID)
This will set the public ID of this EntityRef. |
EntityRef |
setSystemID(java.lang.String systemID)
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 org.jdom.Content |
|---|
clone, detach, equals, getDocument, getParent, getParentElement, hashCode, setParent |
| 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
| Constructor Detail |
|---|
protected EntityRef()
public EntityRef(java.lang.String name)
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)
EntityRef
with the supplied name and system id.
name - String name of element.systemID - system id of the entity reference being constructed
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)
EntityRef
with the supplied name, public id, and system id.
name - String name of element.publicID - public id of the entity reference being constructedsystemID - system id of the entity reference being constructed
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.String getName()
EntityRef.
String - entity name.public java.lang.String getValue()
getValue in class Contentpublic java.lang.String getPublicID()
EntityRef.
If there is no public ID, then this returns null.
EntityRefpublic java.lang.String getSystemID()
EntityRef.
If there is no system ID, then this returns null.
EntityRefpublic EntityRef setName(java.lang.String name)
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 publicID)
EntityRef.
publicID - new public id
EntityRef modified.
IllegalDataException - if the given public ID is not a legal
public ID.public EntityRef setSystemID(java.lang.String systemID)
EntityRef.
systemID - new system id
EntityRef modified.
IllegalDataException - if the given system ID is not a legal
system literal.public java.lang.String toString()
String representation of the
EntityRef, suitable for debugging.
toString in class java.lang.ObjectString - information about the
EntityRef
|
JDOM 1.1.3 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||