org.tentackle.fx.ImageProvider Maven / Gradle / Ivy
/*
* Tentackle - https://tentackle.org.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
package org.tentackle.fx;
import javafx.scene.image.Image;
/**
* Provider and cache for images.
*
* All images are cached.
*
* @author harald
*/
public interface ImageProvider {
/**
* Gets an image.
* There is only one image instance per name.
* The name is a plain name, not a path and no type extension.
*
* Throws IllegalArgumentException if image not found.
*
* @param name the image's name
* @return the image
*/
Image getImage(String name);
}