Public Member Functions | |
EntityRef (String name) | |
EntityRef (String name, String systemID) | |
EntityRef (String name, String publicID, String systemID) | |
Object | clone () |
EntityRef | detach () |
final boolean | equals (Object ob) |
Document | getDocument () |
String | getName () |
Element | getParent () |
String | getPublicID () |
String | getSystemID () |
final int | hashCode () |
EntityRef | setName (String name) |
EntityRef | setPublicID (String publicID) |
EntityRef | setSystemID (String systemID) |
String | toString () |
Protected Member Functions | |
EntityRef () | |
EntityRef | setParent (Element parent) |
Protected Attributes | |
String | name |
String | publicID |
String | systemID |
Object | parent |
EntityRef
Defines an XML entity reference in Java.
org::jdom::EntityRef::EntityRef | ( | ) | [inline, protected] |
Default, no-args constructor for implementations to use if needed.
org::jdom::EntityRef::EntityRef | ( | String | name | ) | [inline] |
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. |
org::jdom::EntityRef::EntityRef | ( | String | name, | |
String | systemID | |||
) | [inline] |
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. |
org::jdom::EntityRef::EntityRef | ( | String | name, | |
String | publicID, | |||
String | systemID | |||
) | [inline] |
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. |
Object org::jdom::EntityRef::clone | ( | ) | [inline] |
EntityRef org::jdom::EntityRef::detach | ( | ) | [inline] |
This detaches the Entity
from its parent, or does nothing if the Entity
has no parent.
Entity
- this Entity
modified. final boolean org::jdom::EntityRef::equals | ( | Object | ob | ) | [inline] |
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
. Document org::jdom::EntityRef::getDocument | ( | ) | [inline] |
String org::jdom::EntityRef::getName | ( | ) | [inline] |
Element org::jdom::EntityRef::getParent | ( | ) | [inline] |
String org::jdom::EntityRef::getPublicID | ( | ) | [inline] |
String org::jdom::EntityRef::getSystemID | ( | ) | [inline] |
final int org::jdom::EntityRef::hashCode | ( | ) | [inline] |
This returns the hash code for this Entity
.
int
- hash code.
This will set the parent of this Entity
.
parent | Element to be new parent. |
Entity
modified. EntityRef org::jdom::EntityRef::setName | ( | String | name | ) | [inline] |
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. |
EntityRef org::jdom::EntityRef::setPublicID | ( | String | publicID | ) | [inline] |
This will set the public ID of this EntityRef
.
publicID | new public id |
EntityRef
modified. IllegalDataException | if the given public ID is not a legal public ID. |
EntityRef org::jdom::EntityRef::setSystemID | ( | String | systemID | ) | [inline] |
This will set the system ID of this EntityRef
.
systemID | new system id |
IllegalDataException | if the given system ID is not a legal system literal. |
EntityRef
modified. String org::jdom::EntityRef::toString | ( | ) | [inline] |
String org::jdom::EntityRef::name [protected] |
The name of the EntityRef
String org::jdom::EntityRef::publicID [protected] |
The PublicID of the EntityRef
String org::jdom::EntityRef::systemID [protected] |
The SystemID of the EntityRef
Object org::jdom::EntityRef::parent [protected] |
Parent element or null if none