de.intarsys.tools.enumeration.EnumItem Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of isrt Show documentation
The basic runtime tools and interfaces for intarsys components.
There is a newer version: 4.11
/*
 * Copyright (c) 2007, intarsys consulting GmbH
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * - Neither the name of intarsys nor the names of its contributors may be used
 *   to endorse or promote products derived from this software without specific
 *   prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package de.intarsys.tools.enumeration;

import java.util.HashMap;
import java.util.Map;

import de.intarsys.tools.message.Message;

/**
 * The abstract superclass for an enumeration implementation.
 * 
 * To implement an enumeration class:
 * 
 * 
 *                 - create a subclass of EnumItem
 *                 - create a final public static attribute named META to the EnumMeta of the class.
 *                     final public static EnumMeta META = getMeta(XYZ.class);
 *                 - create a final public static attribute for every member of the enumeration.
 *                     public static final XYZ ABC = new XYZ("abxc","My ABC");
 * 
 */
public abstract class EnumItem implements Comparable {
	private static final Map META = new HashMap();

	private static int WEIGHT = 0;

	protected static EnumMeta getMeta(Class clazz) {
		EnumMeta result = (EnumMeta) META.get(clazz);
		if (result == null) {
			result = new EnumMeta(clazz);
			META.put(clazz, result);
		}
		return result;
	}

	private String iconName;

	/** The enumeration id */
	private final String id;

	/** The label to use for the enumeration value */
	private String label;

	private Message message;

	/**
	 * An integer defining the natural order of the items.
	 */
	private final int weight;

	protected EnumItem(String id) {
		this.id = id;
		this.message = new Message(this, id);
		this.weight = WEIGHT++;
		getMeta().addItem(this);
	}

	protected EnumItem(String id, int weight) {
		super();
		this.id = id;
		this.message = new Message(this, id);
		this.weight = weight;
		getMeta().addItem(this);
	}

	protected EnumItem(String id, Message message) {
		this(id, message, WEIGHT++);
	}

	protected EnumItem(String id, Message message, int weight) {
		super();
		this.id = id;
		this.message = message;
		this.weight = weight;
		getMeta().addItem(this);
	}

	/**
	 * 
	 */
	protected EnumItem(String id, String label) {
		this(id, label, WEIGHT++);
	}

	protected EnumItem(String id, String label, int weight) {
		super();
		this.id = id;
		this.label = label;
		this.weight = weight;
		getMeta().addItem(this);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see java.lang.Comparable#compareTo(java.lang.Object)
	 */
	public int compareTo(Object o) {
		EnumItem other = (EnumItem) o;
		return (int) Math.signum(this.getWeight() - other.getWeight());
	}

	public String getDescription() {
		return getTip();
	}

	public String getIconName() {
		return iconName;
	}

	public String getId() {
		return id;
	}

	public String getLabel() {
		if (label == null) {
			label = message.get();
		}
		return label;
	}

	public String getLocalizedLabel() {
		return getLabel();
	}

	public Message getMessage() {
		return message;
	}

	protected EnumMeta getMeta() {
		return getMeta(getClass());
	}

	public String getTip() {
		return getLabel();
	}

	protected int getWeight() {
		return weight;
	}

	protected void setDefault() {
		getMeta().setDefault(this);
	}

	protected void setIconName(String iconName) {
		this.iconName = iconName;
	}

	@Override
	public String toString() {
		return getLabel();
	}
}