mmb.menu.wtool.WindowToolModel Maven / Gradle / Ivy

Go to download
/**
 * 
 */
package mmb.menu.wtool;

import java.util.Objects;
import java.util.function.Supplier;

import javax.swing.Icon;

import monniasza.collects.Identifiable;

/**
 * An abstract definition of a window tool
 * @author oskar
 */
public class WindowToolModel implements Identifiable {
	private Icon icon;
	private final String id;
	/**
	 * Creates a window tool model
	 * @param icon icon of the tool
	 * @param instantiator the {@link Supplier} factory of the window tool
	 * @param id the unique ID of the tool
	 * @throws NullPointerException if {@code instantiator} or {@code id} is null
	 */
	public WindowToolModel(Icon icon, Supplier instantiator, String id) {
		this.icon = icon;
		this.instantiator = Objects.requireNonNull(instantiator, "instantiator is null");
		this.id = Objects.requireNonNull(id, "id is null");
	}
	/**
	 * The {@link Supplier} factory of the window tool
	 */
	public final Supplier instantiator;
	/**
	 * @return the icon
	 */
	public Icon getIcon() {
		return icon;
	}
	/**
	 * @param icon the icon to set
	 */
	public void setIcon(Icon icon) {
		this.icon = icon;
	}
	/**
	 * @return a new instance of given window tool
	 */
	public WindowTool create() {
		return instantiator.get();
	}
	@Override
	public String toString() {
		return "WindowToolModel [icon=" + icon + ", id=" + id + ", instantiator=" + instantiator + "]";
	}
	@Override
	public String id() {
		return id;
	}
}