Mercurial > repos > pfrommolt > ngsrich
diff NGSrich_0.5.5/src/org/jdom/Content.java @ 0:89ad0a9cca52 default tip
Uploaded
author | pfrommolt |
---|---|
date | Mon, 21 Nov 2011 08:12:19 -0500 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/NGSrich_0.5.5/src/org/jdom/Content.java Mon Nov 21 08:12:19 2011 -0500 @@ -0,0 +1,192 @@ +/*-- + + $Id: Content.java,v 1.6 2007/11/10 05:28:58 jhunter Exp $ + + Copyright (C) 2007 Jason Hunter & Brett McLaughlin. + All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + + 1. Redistributions of source code must retain the above copyright + notice, this list of conditions, and the following disclaimer. + + 2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions, and the disclaimer that follows + these conditions in the documentation and/or other materials + provided with the distribution. + + 3. The name "JDOM" must not be used to endorse or promote products + derived from this software without prior written permission. For + written permission, please contact <request_AT_jdom_DOT_org>. + + 4. Products derived from this software may not be called "JDOM", nor + may "JDOM" appear in their name, without prior written permission + from the JDOM Project Management <request_AT_jdom_DOT_org>. + + In addition, we request (but do not require) that you include in the + end-user documentation provided with the redistribution and/or in the + software itself an acknowledgement equivalent to the following: + "This product includes software developed by the + JDOM Project (http://www.jdom.org/)." + Alternatively, the acknowledgment may be graphical using the logos + available at http://www.jdom.org/images/logos. + + THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED + WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + DISCLAIMED. IN NO EVENT SHALL THE JDOM AUTHORS OR THE PROJECT + CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, + OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + SUCH DAMAGE. + + This software consists of voluntary contributions made by many + individuals on behalf of the JDOM Project and was originally + created by Jason Hunter <jhunter_AT_jdom_DOT_org> and + Brett McLaughlin <brett_AT_jdom_DOT_org>. For more information + on the JDOM Project, please see <http://www.jdom.org/>. + + */ + +package org.jdom; + +import java.io.*; + +/** + * Superclass for JDOM objects which can be legal child content + * of {@link org.jdom.Parent} nodes. + * + * @see org.jdom.Comment + * @see org.jdom.DocType + * @see org.jdom.Element + * @see org.jdom.EntityRef + * @see org.jdom.Parent + * @see org.jdom.ProcessingInstruction + * @see org.jdom.Text + * + * @author Bradley S. Huffman + * @author Jason Hunter + * @version $Revision: 1.6 $, $Date: 2007/11/10 05:28:58 $ + */ +public abstract class Content implements Cloneable, Serializable { + + protected Parent parent = null; + + protected Content() {} + + /** + * Detaches this child from its parent or does nothing if the child + * has no parent. + * + * @return this child detached + */ + public Content detach() { + if (parent != null) { + parent.removeContent(this); + } + return this; + } + + /** + * Return this child's parent, or null if this child is currently + * not attached. The parent can be either an {@link Element} + * or a {@link Document}. + * + * @return this child's parent or null if none + */ + public Parent getParent() { + return parent; + } + + /** + * 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. + * + * @return the containing Element or null if unattached or a root element + */ + public Element getParentElement() { + Parent parent = getParent(); + return (Element) ((parent instanceof Element) ? parent : null); + } + + /** + * Sets the parent of this Content. The caller is responsible for removing + * any pre-existing parentage. + * + * @param parent new parent element + * @return the target element + */ + protected Content setParent(Parent parent) { + this.parent = parent; + return this; + } + + /** + * Return this child's owning document or null if the branch containing + * this child is currently not attached to a document. + * + * @return this child's owning document or null if none + */ + public Document getDocument() { + if (parent == null) return null; + return parent.getDocument(); + } + + + /** + * Returns the XPath 1.0 string value of this child. + * + * @return xpath string value of this child. + */ + public abstract String getValue(); + + /** + * Returns a deep, unattached copy of this child and its descendants + * detached from any parent or document. + * + * @return a detached deep copy of this child and descendants + */ + public Object clone() { + try { + Content c = (Content)super.clone(); + c.parent = null; + return c; + } catch (CloneNotSupportedException e) { + //Can not happen .... + //e.printStackTrace(); + return null; + } + } + + /** + * 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. + * + * @param ob <code>Object</code> to compare to. + * @return <code>boolean</code> - whether the <code>Content</code> is + * equal to the supplied <code>Object</code>. + */ + public final boolean equals(Object ob) { + return (ob == this); + } + + /** + * This returns the hash code for this <code>Content</code> item. + * + * @return <code>int</code> - hash code. + */ + public final int hashCode() { + return super.hashCode(); + } +}