001    /*
002     * Copyright 2002-2004 the original author or authors.
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 implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.springframework.richclient.image;
017    
018    import javax.swing.Icon;
019    
020    /**
021     * A loader and cache for Swing <code>ImageIcons</code>.
022     * 
023     * @author Keith Donald
024     * @see javax.swing.ImageIcon
025     */
026    public interface IconSource {
027    
028        /**
029         * Return an <code>ImageIcon</code> using its <code>String</code> key.
030         * 
031         * @param key
032         *            a key for the icon.
033         * @return The image icon.
034         * @throws NoSuchImageResourceException,
035         *             if no resource is found and no broken image indicator is set.
036         */
037        public Icon getIcon(String key);
038    
039    }