/*-- 

 $Id: DataConversionException.java,v 1.5 2001/04/27 18:21:19 jhunter Exp $

 Copyright (C) 2000 Brett McLaughlin & Jason Hunter.
 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 license@jdom.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 (pm@jdom.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 Brett McLaughlin <brett@jdom.org> and 
 Jason Hunter <jhunter@jdom.org>.  For more information on the 
 JDOM Project, please see <http://www.jdom.org/>.
 
 */

package org.jdom;

/**
 * <p>
 *   This helper class holds convenience methods often useful when using JDOM.
 * </p>
 *
 * @author Kent C. Johnson
 * @version 1.0
 */
public class JDOMHelper {

    private static final String CVS_ID = 
      "@(#) $RCSfile: DataConversionException.java,v $ $Revision: 1.5 $ $Date: 2001/04/27 18:21:19 $ $Name:  $";

    /**
     * <p>
     *   This convenience method returns the textual content of the named
     *   child element of the parent element given, or returns an empty
     *   <code>String</code> ("") if the child has no textual content.
     *   However, if the child does not exist, <code>null</code> is returned.
     * </p>
     *
     * @param parent parent element with the child
     * @param name the name of the child
     * @return text content for the named child, or null if none
     */
    public static String getChildText(Element parent, String name) {
        Element child = parent.getChild(name);
        if (child == null) {
            return null;
        } else {
            return child.getText();
        }
    }

    /**
     * <p>
     *   This convenience method returns the trimmed textual content of the 
     *   named child element of the parent element given, or returns null if
     *   there's no such child.
     *   See <code>{@link Element#getTextTrim()}</code> for details of text
     *   trimming.
     * </p>
     *
     * @param parent parent element with the child
     * @param name the name of the child
     * @return trimmed text content for the named child, or null if none
     */
    public static String getChildTextTrim(Element parent, String name) {
        Element child = parent.getChild(name);
        if (child == null) {
            return null;
        } else {
            return child.getTextTrim();
        }
    }

    /**
     * <p>
     *   This convenience method returns the normalized textual content of the 
     *   named child element of the parent element given, or returns null if
     *   there's no such child.  
     *   See <code>{@link Element#getTextNormalize()}</code> for details of
     *   text normalizing.
     * </p>
     *
     * @param parent parent element with the child
     * @param name the name of the child
     * @return normalized text content for the named child, or null if none
     */
    public static String getChildTextNormalize(Element parent, String name) {
        Element child = parent.getChild(name);
        if (child == null) {
            return null;
        } else {
            return child.getTextNormalize();
        }
    }

    /**
     * <p>
     *   A namespace-aware version of <code>
     *   {@link #getChildText(org.jdom.Element, java.lang.String)}</code>.
     * </p>
     *
     * @param parent parent element with the child
     * @param name the name of the child
     * @param ns the namespace of the child
     * @return text content for the named child, or null if none
     */
    public static String getChildText(Element parent,
                                      String name, Namespace ns) {
        Element child = parent.getChild(name, ns);
        if (child == null) {
            return null;
        } else {
            return child.getText();
        }
    }

    /**
     * <p>
     *   A namespace-aware version of <code>
     *   {@link #getChildTextTrim(org.jdom.Element, java.lang.String)}</code>.
     * </p>
     *
     * @param parent parent element with the child
     * @param name the name of the child
     * @param ns the namespace of the child
     * @return trimmed text content for the named child, or null if none
     */
    public static String getChildTextTrim(Element parent,
                                          String name, Namespace ns) {
        Element child = parent.getChild(name, ns);
        if (child == null) {
            return null;
        } else {
            return child.getTextTrim();
        }
    }

    /**
     * <p>
     *   A namespace-aware version of <code>
     *   {@link #getChildTextNormalize(org.jdom.Element, java.lang.String)}
     *   </code>.
     * </p>
     *
     * @param parent parent element with the child
     * @param name the name of the child
     * @param ns the namespace of the child
     * @return normalized text content for the named child, or null if none
     */
    public static String getChildTextNormalize(Element parent,
                                               String name, Namespace ns) {
        Element child = parent.getChild(name, ns);
        if (child == null) {
            return null;
        } else {
            return child.getTextNormalize();
        }
    }


}