WikiException.java

/**
 * WikiException.java
 * Copyright (C)2010 Nicholas Killewald
 * 
 * This file is distributed under the terms of the BSD license.
 * The source package should have a LICENSE file at the toplevel.
 */
package net.exclaimindustries.geohashdroid.wiki;

/**
 * A <code>WikiException</code> is thrown when some problem happens with the
 * wiki.  This can be anything from bad XML to an error in logging in to
 * whatever.  This stores a text ID to be translated by the Activity that needs
 * to display it.
 * 
 * @author Nicholas Killewald
 */
public class WikiException extends Exception {
    private static final long serialVersionUID = 1L;

    private int mTextId = -1;
    
    public WikiException(int textId) {
        super();
        mTextId = textId;
    }
    
    @Override
    public String getMessage() {
        return "Wiki exception, text ID " + mTextId + " (you shouldn't see this)";
    }

    /**
     * Gets the ID of the text string associated with this wiki exception.
     * Conveniently, that's an int AND it's unique, allowing us to use that as
     * an indentifier for just what error happened in the first place!  Say!
     *
     * @return the text ID of the exception's cause
     */
    public int getErrorTextId() {
        return mTextId;
    }
}