org::jdom::EntityRef Class Reference

Inheritance diagram for org::jdom::EntityRef:

List of all members.

Public Member Functions
	EntityRef (String name)
	EntityRef (String name, String systemID)
	EntityRef (String name, String publicID, String systemID)
String	getName ()
String	getValue ()
String	getPublicID ()
String	getSystemID ()
EntityRef	setName (String name)
EntityRef	setPublicID (String publicID)
EntityRef	setSystemID (String systemID)
String	toString ()
Protected Member Functions
	EntityRef ()
Protected Attributes
String	name
String	publicID
String	systemID

---

Detailed Description

An XML entity reference. Methods allow the user to manage its name, public id, and system id.

Version:

Revision

1.21

,

Date

2004/02/27 11:32:57

Author:

Brett McLaughlin

Jason Hunter

Philip Nelson

---

Constructor & Destructor Documentation

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. Parameters: name  String name of element. Exceptions: 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. Parameters: name  String name of element. systemID  system id of the entity reference being constructed Exceptions: 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. Parameters: name  String name of element. publicID  public id of the entity reference being constructed systemID  system id of the entity reference being constructed Exceptions: 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.

---

Member Function Documentation

String org::jdom::EntityRef::getName (   )  [inline]

This returns the name of the EntityRef. Returns: String - entity name.

String org::jdom::EntityRef::getPublicID (   )  [inline]

This will return the publid ID of this EntityRef. If there is no public ID, then this returns null. Returns: public ID of this EntityRef

String org::jdom::EntityRef::getSystemID (   )  [inline]

This will return the system ID of this EntityRef. If there is no system ID, then this returns null. Returns: system ID of this EntityRef

String org::jdom::EntityRef::getValue (   )  [inline, virtual]

Returns the empty string since entity references don't have an XPath 1.0 string value. Returns: the empty string Implements org::jdom::Content.

EntityRef org::jdom::EntityRef::setName (  String  name  )  [inline]

This will set the name of this EntityRef. Parameters: name  new name of the entity Returns: this EntityRef modified. Exceptions: 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. Parameters: publicID  new public id Returns: this EntityRef modified. Exceptions: 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. Parameters: systemID  new system id Exceptions: IllegalDataException  if the given system ID is not a legal system literal. Returns: this EntityRef modified.

String org::jdom::EntityRef::toString (   )  [inline]

This returns a String representation of the EntityRef, suitable for debugging. Returns: String - information about the EntityRef

---

Member Data Documentation

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

---

The documentation for this class was generated from the following file:

• src/java/org/jdom/EntityRef.java

---