/* $Id: MathematicalState.java,v 1.1 2007/04/01 07:59:48 m31 Exp $
 *
 * This file is part of the project "Hilbert II" - http://www.qedeq.org
 *
 * Copyright 2000-2007,  Michael Meyling <mime@qedeq.org>.
 *
 * "Hilbert II" is free software; you can redistribute
 * it and/or modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 */

package org.qedeq.kernel.bo.module;


/**
 * Represents a mathematical module state.
 *
 * @version $Revision: 1.1 $
 * @author  Michael Meyling
 */
public final class MathematicalState {

    /** Unchecked. */
    public static final MathematicalState STATE_UNCHECKED
        = new MathematicalState(MathematicalStateDescriptions.STATE_STRING_UNCHECKED,
            false, MathematicalStateDescriptions.STATE_CODE_UNCHECKED);

    /** External checking. */
    public static final MathematicalState STATE_EXTERNAL_CHECKING
        = new MathematicalState(MathematicalStateDescriptions.STATE_STRING_EXTERNAL_CHECKING,
            false, MathematicalStateDescriptions.STATE_CODE_EXTERNAL_CHECKING);

    /** Successfully created. */
    public static final MathematicalState STATE_EXTERNAL_CHECK_FAILED
        =  new MathematicalState(MathematicalStateDescriptions.STATE_STRING_EXTERNAL_CHECK_FAILED,
            true, MathematicalStateDescriptions.STATE_CODE_EXTERNAL_CHECK_FAILED);

    /** Internal checking phase. */
    public static final MathematicalState STATE_INTERNAL_CHECKING
        = new MathematicalState(MathematicalStateDescriptions.STATE_STRING_INTERNAL_CHECKING,
            false, MathematicalStateDescriptions.STATE_CODE_INTERNAL_CHECKING);

    /** Internal check failed. */
    public static final MathematicalState STATE_INTERNAL_CHECK_FAILED
        =  new MathematicalState(MathematicalStateDescriptions.STATE_STRING_INTERNAL_CHECK_FAILED,
            true, MathematicalStateDescriptions.STATE_CODE_INTERNAL_CHECK_FAILED);


    /** Successfully completely checked. */
    public static final MathematicalState STATE_CHECKED
        = new MathematicalState(MathematicalStateDescriptions.STATE_STRING_COMPLETELY_CHECKED,
            false, MathematicalStateDescriptions.STATE_CODE_COMPLETELY_CHECKED);


    /** meaning of this state. */
    private final String text;

    /** is this state a failure? */
    private final boolean failure;

    /** Code for state. */
    private final int code;

    /**
     * Creates new module state.
     *
     * @param   text    meaning of this state, <code>null</code> is not permitted.
     * @param   failure is this a failure state?
     * @param   code    code of this state.
     * @throws  IllegalArgumentException    text == <code>null</code>
     */
    private MathematicalState(final String text, final boolean failure, final int code) {
        this.text = text;
        if (this.text == null) {
            throw new IllegalArgumentException("text==null");
        }
        this.failure = failure;
        this.code = code;
    }

    /**
     * Get meaning of module state.
     *
     * @return  meaning of module state.
     */
    public final String getText() {
        return this.text;
    }

    /**
     * Is this a failure state?
     *
     * @return  is this a failure state?
     */
    public final boolean isFailure() {
        return this.failure;
    }

    /**
     * Get module state code.
     *
     * @return  Module state.
     */
    public final int getCode() {
        return this.code;
    }

    /*  (non-Javadoc)
     * @see java.lang.Object#toString()
     */
    public final String toString() {
        return this.text;
    }

    /*  (non-Javadoc)
     * @see java.lang.Object#hashCode()
     */
    public final int hashCode() {
        return this.text.hashCode();
    }

    /*  (non-Javadoc)
     * @see java.lang.Object#equals(java.lang.Object)
     */
    public final boolean equals(final Object obj) {
        if (obj == null || !(obj instanceof MathematicalState)) {
            return false;
        }
        return text.equals(((MathematicalState) obj).text);
    }

}