001    /*
002     * Copyright (c) 2005 Einar Pehrson <einar@pehrson.nu>.
003     *
004     * This file is part of
005     * CleanSheets - a spreadsheet application for the Java platform.
006     *
007     * CleanSheets is free software; you can redistribute it and/or modify
008     * it under the terms of the GNU General Public License as published by
009     * the Free Software Foundation; either version 2 of the License, or
010     * (at your option) any later version.
011     *
012     * CleanSheets is distributed in the hope that it will be useful,
013     * but WITHOUT ANY WARRANTY; without even the implied warranty of
014     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
015     * GNU General Public License for more details.
016     *
017     * You should have received a copy of the GNU General Public License
018     * along with CleanSheets; if not, write to the Free Software
019     * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
020     */
021    package csheets.core.formula.lang;
022    
023    import csheets.core.formula.compiler.FormulaCompilationException;
024    
025    /**
026     * An exception that is thrown if an unknown language element is requested.
027     * @author Einar Pehrson
028     */
029    public class UnknownElementException extends FormulaCompilationException {
030    
031            /** The serialVersionUID of the UnknownElementException.java */
032            private static final long serialVersionUID = 1104385312243490098L;
033    
034            /** The identifier of the unknown element */
035            private String identifier;
036    
037            /**
038             * Creates a new unknown identifier exception.
039             * @param identifier the identifier of the unknown element
040             */
041            public UnknownElementException(String identifier) {
042                    this.identifier = identifier;
043            }
044    
045            /**
046             * Returns the identifier of the unknown element.
047             * @return the identifier of the unknown element
048             */
049            public String getIdentifier() {
050                    return identifier;
051            }
052    
053            /**
054             * Returns a message describing the exception.
055             * @return a message describing the exception
056             */
057            public String getMessage() {
058                    return "Unknown element identifier: " + identifier + ".";
059            }
060    
061            /**
062             * Returns a string representation of the exception.
063             * @return a string representation of the exception
064             */
065            public String toString() {
066                    return getMessage();
067            }
068    }