org.jdom
public class EntityRef extends Content
Modifier and Type | Field and Description |
---|---|
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 |
Modifier | Constructor and Description |
---|---|
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. |
Modifier and Type | Method and Description |
---|---|
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. |
clone, detach, equals, getDocument, getParent, getParentElement, hashCode, setParent
protected java.lang.String name
EntityRef
protected java.lang.String publicID
EntityRef
protected java.lang.String systemID
EntityRef
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 constructedIllegalNameException
- 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 constructedIllegalDataException
- if the given system ID is not a legal
system literal or the the given public ID is not a
legal public IDIllegalNameException
- if the given name is not a legal
XML name.public java.lang.String getName()
EntityRef
.String
- entity name.public java.lang.String getValue()
public java.lang.String getPublicID()
EntityRef
.
If there is no public ID, then this returns null
.EntityRef
public java.lang.String getSystemID()
EntityRef
.
If there is no system ID, then this returns null
.EntityRef
public EntityRef setName(java.lang.String name)
EntityRef
.name
- new name of the entityEntityRef
modified.IllegalNameException
- if the given name is not a legal
XML name.public EntityRef setPublicID(java.lang.String publicID)
EntityRef
.publicID
- new public idEntityRef
modified.IllegalDataException
- if the given public ID is not a legal
public ID.public EntityRef setSystemID(java.lang.String systemID)
EntityRef
.systemID
- new system idEntityRef
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.Object
String
- information about the
EntityRef
Copyright © 2007 Jason Hunter, Brett McLaughlin. All Rights Reserved.