---

EntityRef Class Reference

List of all members.

Public Methods
	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 newPublicID)
EntityRef	setSystemID (String newSystemID)
String	toString ()
Protected Methods
	EntityRef ()
EntityRef	setParent (Element parent)
Protected Attributes
String	name
String	publicID
String	systemID
Element	parent

---

Detailed Description

EntityRef Defines an XML entity reference in Java.

Author:

Brett McLaughlin , Jason Hunter , Philip Nelson

Version:

Revision:

1.7

,

Date:

2002/02/12 06:34:09

---

Constructor & Destructor Documentation

EntityRef::EntityRef (    )  [inline, protected]

Default, no-args constructor for implementations to use if needed.

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.

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. Exceptions: IllegalNameException  if the given name is not a legal XML name. IllegalDataException  if the given system ID is not a legal system literal.

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. 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

Object EntityRef::clone (    )  [inline]

This will return a clone of this EntityRef. Returns: Object - clone of this EntityRef.

EntityRef EntityRef::detach (    )  [inline]

This detaches the Entity from its parent, or does nothing if the Entity has no parent. Returns: Entity - this Entity modified.

final boolean EntityRef::equals (  Object    ob )  [inline]

This tests for equality of this Entity to the supplied Object. Parameters: ob  Object to compare to. Returns: boolean - whether the Entity is equal to the supplied Object.

Document EntityRef::getDocument (    )  [inline]

This retrieves the owning Document for this Entity, or null if not a currently a member of a Document. Returns: Document owning this Entity, or null.

String EntityRef::getName (    )  [inline]

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

Element EntityRef::getParent (    )  [inline]

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

String 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 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

final int EntityRef::hashCode (    )  [inline]

This returns the hash code for this Entity. Returns: int - hash code.

EntityRef 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 EntityRef::setParent (  Element    parent )  [inline, protected]

This will set the parent of this Entity. Parameters: parent  Element to be new parent. Returns: this Entity modified.

EntityRef EntityRef::setPublicID (  String    newPublicID )  [inline]

This will set the public ID of this EntityRef. Parameters: newPublicID  new public id Returns: this EntityRef modified. Exceptions: IllegalDataException  if the given public ID is not a legal public ID.

EntityRef EntityRef::setSystemID (  String    newSystemID )  [inline]

This will set the system ID of this EntityRef. Parameters: newSystemID  new system id Exceptions: IllegalDataException  if the given system ID is not a legal system literal. Returns: this EntityRef modified.

String EntityRef::toString (    )  [inline]

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

---

Member Data Documentation

String EntityRef::name [protected]

The name of the EntityRef

Element EntityRef::parent [protected]

Parent element or null if none

String EntityRef::publicID [protected]

The PublicID of the EntityRef

String EntityRef::systemID [protected]

The SystemID of the EntityRef

---

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

• EntityRef.java

---