001    /*
002     * Copyright 2005 Stephen J. McConnell.
003     *
004     * Licensed  under the  Apache License,  Version 2.0  (the "License");
005     * you may not use  this file  except in  compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     *   http://www.apache.org/licenses/LICENSE-2.0
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed  under the  License is distributed on an "AS IS" BASIS,
012     * WITHOUT  WARRANTIES OR CONDITIONS  OF ANY KIND, either  express  or
013     * implied.
014     *
015     * See the License for the specific language governing permissions and
016     * limitations under the License.
017     */
018    
019    package net.dpml.lang;
020    
021    /**
022     * Exception to indicate an error arrising from the use of an unknown key.
023     *
024     * @author <a href="http://www.dpml.net">Digital Product Meta Library</a>
025     * @version 1.1.0
026     */
027    public class UnknownKeyException extends Exception
028    {
029       /**
030        * Serial version identifier.
031        */
032        static final long serialVersionUID = 1L;
033        
034        private final String m_key;
035    
036        /**
037         * Construct a new <code>UnknownKeyException</code> instance.
038         *
039         * @param key the unknown key
040         */
041        public UnknownKeyException( final String key )
042        {
043            super( "[" + key + "]" );
044            
045            m_key = key;
046        }
047    
048       /**
049        * Return the key.
050        * @return the key
051        */
052        public String getKey()
053        {
054            return m_key;
055        }
056    }
057