Main Page | Class Hierarchy | Class List | Class Members

org::jdom::Content Class Reference

Inheritance diagram for org::jdom::Content:

org::jdom::Comment org::jdom::DocType org::jdom::Element org::jdom::EntityRef org::jdom::ProcessingInstruction org::jdom::Text org::jdom::CDATA List of all members.

Public Member Functions

Content detach ()
Parent getParent ()
Element getParentElement ()
Document getDocument ()
abstract String getValue ()
Object clone ()
final boolean equals (Object ob)
final int hashCode ()

Protected Member Functions

Content setParent (Parent parent)

Protected Attributes

Parent parent = null

Detailed Description

Superclass for JDOM objects which can be legal child content of org.jdom.Parent nodes.

See also:
org.jdom.Comment

org.jdom.DocType

org.jdom.Element

org.jdom.EntityRef

org.jdom.Parent

org.jdom.ProcessingInstruction

org.jdom.Text

Author:
Bradley S. Huffman

Jason Hunter

Version:
Revision
1.5
,
Date
2004/09/07 06:37:20


Member Function Documentation

Object org::jdom::Content::clone  )  [inline]
 

Returns a deep, unattached copy of this child and its descendants detached from any parent or document.

Returns:
a detached deep copy of this child and descendants

Reimplemented in org::jdom::Element, org::jdom::ProcessingInstruction, and org::jdom::Text.

Content org::jdom::Content::detach  )  [inline]
 

Detaches this child from its parent or does nothing if the child has no parent.

Returns:
this child detached

final boolean org::jdom::Content::equals Object  ob  )  [inline]
 

This tests for equality of this Content object to the supplied object. Content items are considered equal only if they are referentially equal (i.e. the same object). User code may choose to compare objects based on their properties instead.

Parameters:
ob Object to compare to.
Returns:
boolean - whether the Content is equal to the supplied Object.

Document org::jdom::Content::getDocument  )  [inline]
 

Return this child's owning document or null if the branch containing this child is currently not attached to a document.

Returns:
this child's owning document or null if none

Parent org::jdom::Content::getParent  )  [inline]
 

Return this child's parent, or null if this child is currently not attached. The parent can be either an Element or a Document.

Returns:
this child's parent or null if none

Element org::jdom::Content::getParentElement  )  [inline]
 

A convenience method that returns any parent element for this element, or null if the element is unattached or is a root element. This was the original behavior of getParent() in JDOM Beta 9 which began returning Parent in Beta 10. This method provides a convenient upgrade path for JDOM Beta 10 and 1.0 users.

Returns:
the containing Element or null if unattached or a root element

abstract String org::jdom::Content::getValue  )  [pure virtual]
 

Returns the XPath 1.0 string value of this child.

Returns:
xpath string value of this child.

Implemented in org::jdom::Comment, org::jdom::DocType, org::jdom::Element, org::jdom::EntityRef, org::jdom::ProcessingInstruction, and org::jdom::Text.

final int org::jdom::Content::hashCode  )  [inline]
 

This returns the hash code for this Content item.

Returns:
int - hash code.

Content org::jdom::Content::setParent Parent  parent  )  [inline, protected]
 

Sets the parent of this Content. The caller is responsible for removing any pre-existing parentage.

Parameters:
parent new parent element
Returns:
the target element


The documentation for this class was generated from the following file:
Generated on Thu Dec 9 10:42:04 2004 for JDOM by  doxygen 1.3.9.1