History.java

/*
 * Copyright (C) 2012 The CyanogenMod Project
 *
 * 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.
 */

package com.cyanogenmod.filemanager.model;

import com.cyanogenmod.filemanager.parcelables.HistoryNavigable;

import java.io.Serializable;

/**
 * A class that holds the a navigation history information.
 */
public class History implements Serializable, Comparable<History> {

    private static final long serialVersionUID = -8891185225878742265L;

    private final int mPosition;
    private final HistoryNavigable mItem;

    /**
     * Constructor of <code>History</code>.
     *
     * @param position The history position
     * @param item The item that holds the history information
     */
    public History(int position, HistoryNavigable item) {
        super();
        this.mPosition = position;
        this.mItem = item;
    }

    /**
     * Method that returns the position of the history.
     *
     * @return int The history position
     */
    public int getPosition() {
        return this.mPosition;
    }

    /**
     * Method that returns the item that holds the history information.
     *
     * @return HistoryNavigable The item that holds the history information
     */
    public HistoryNavigable getItem() {
        return this.mItem;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((this.mItem == null) ? 0 : this.mItem.hashCode());
        result = prime * result + this.mPosition;
        return result;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        History other = (History) obj;
        if (this.mItem == null) {
            if (other.mItem != null) {
                return false;
            }
        } else if (!this.mItem.equals(other.mItem)) {
            return false;
        }
        if (this.mPosition != other.mPosition) {
            return false;
        }
        return true;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public int compareTo(History another) {
        return Integer.valueOf(this.mPosition).compareTo(Integer.valueOf(another.mPosition));
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public String toString() {
        return "History [position=" + this.mPosition //$NON-NLS-1$
                + ", item=" + String.valueOf(this.mItem) + "]";  //$NON-NLS-1$//$NON-NLS-2$
    }

}