package org.litesoft.core.util;

import java.util.*;

// Copyright Status:
//
// All Software available from LiteSoft.org (including this file) is
// hereby released into the public domain.
//
// It is free!  As in, you may use it freely in both commercial and
// non-commercial applications, bundle it with your software
// distribution, include it on a CD-ROM, list the source code in a book,
// mirror the documentation at your own web site, or use it in any other
// way you see fit.
//
// NO Warranty!
//
// All software is provided "as is".
//
// There is ABSOLUTELY NO WARRANTY OF ANY KIND: not for the design, fitness
// (for a particular purpose), level of errors (or lack thereof), or
// applicability of this software.  The entire risk as to the quality
// and performance of this software is with you.  Should this software
// prove defective, you assume the cost of all necessary servicing, repair
// or correction.
//
// In no event unless required by applicable law or agreed to in writing
// will any party who created or may modify and/or redistribute this
// software, be liable to you for damages, including any general,
// special, incidental or consequential damages arising out of the use or
// inability to use this software (including but not limited to loss of
// data or data being rendered inaccurate or losses sustained by you or
// third parties or a failure of this software to operate with any
// other programs), even if such holder or other party has been advised
// of the possibility of such damages.
//
// NOTE: Should you discover a bug, have a recogmendation for a change, wish
// to submit modifications, or wish to add new classes/functionality,
// please email them to:
//
//        changes@litesoft.org
//

/**
 * A utility class with various static methods for Iterator related
 * functions.<p>
 * <p/>
 * <p/>
 * When the first parameter is the appropriate type (Iterator), and can NOT be
 * null, by convention, I place these methods in a aaaHelper class.<p>
 * <p/>
 * See <a href="IteratorHelper.html">IteratorHelper</a><p>
 * <p/>
 * This class is non-instantiable.<p>
 *
 * @author George Smith
 * @version 1.0 7/28/01
 */

public class IteratorUtil
{
    private IteratorUtil()
    {
    }

    /**
     * Returns a debug/human friendly <i>label</i>ed String that represents
     * the <i>iterator</i>.<p>
     *
     * @param pIterator the Iterator to dump (null OK).
     * @param pLabel    the label for the Iterator (null OK).<p>
     *
     * @return A <i>label</i>ed String that represents <i>iterator</i>.
     */
    public static String toString( Iterator pIterator, String pLabel )
    {
        if ( pIterator != null )
        {
            return IteratorHelper.toString( pIterator, pLabel );
        }

        return ((pLabel == null) ? "" : pLabel + ": ") + "null";
    }
}