package org.apache.maven.jxr.util;

/* ====================================================================
 *   Copyright 2001-2004 The Apache Software Foundation.
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 * ====================================================================
 */

/**
 * A StringEntry represents a value found by the tokenizer. The index is where
 * this StringEntry was found in the source string
 */
public class StringEntry implements Comparable
{

    private String value = null;
    private int index = 0;

    /**
     * Constructor for the StringEntry object
     *
     * @param value
     * @param index
     */
    public StringEntry(String value,
                       int index)
    {

        this.value = value;
        this.index = index;
    }

    /** Gets the index attribute of the StringEntry object */
    public int getIndex()
    {
        return this.index;
    }

    /** Description of the Method */
    public String toString()
    {
        return this.value;
    }

    /** Compare two objects for equality.  */
    public int compareTo(Object obj)
    {
        //right now only sort by the index.

        if (obj instanceof StringEntry == false)
        {

            throw new IllegalArgumentException("object must be a StringEntry");
        }

        StringEntry se = (StringEntry) obj;

        if (se.getIndex() < this.getIndex())
        {
            return -1;
        }
        else if (se.getIndex() == this.getIndex())
        {
            return 0;
        }
        else
        {
            return 1;
        }

    }

}

