org::jdom::EntityRef Class Reference

List of all members.

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

Detailed Description

EntityRef Defines an XML entity reference in Java.

Author:
Brett McLaughlin

Jason Hunter

Philip Nelson

Version:
Revision
1.13
,
Date
2003/04/08 04:14:49


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.
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.
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 org::jdom::EntityRef::clone (  )  [inline]

This will return a clone of this EntityRef.

Returns:
Object - clone of this EntityRef.

EntityRef org::jdom::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 org::jdom::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 org::jdom::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 org::jdom::EntityRef::getName (  )  [inline]

This returns the name of the EntityRef.

Returns:
String - entity name.

Element org::jdom::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 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

final int org::jdom::EntityRef::hashCode (  )  [inline]

This returns the hash code for this Entity.

Returns:
int - hash code.

EntityRef org::jdom::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 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

Object org::jdom::EntityRef::parent [protected]

Parent element or null if none


The documentation for this class was generated from the following file:
Generated on Sun Nov 5 16:02:37 2006 for JDOM by  doxygen 1.5.1