IThing.java

package org.archstudio.bna;

import java.util.Map;
import java.util.Set;

import org.archstudio.bna.keys.IThingKey;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;

/**
 * Describes a BNA Thing with zero or more properties.
 */
@NonNullByDefault
public interface IThing {

	/**
	 * Gets a peer that draws the graphical representation of this Thing.
	 * 
	 * @return A new instance of the Thing's peer.
	 */
	public IThingPeer<? extends IThing> createPeer(IBNAView view, ICoordinateMapper cm);

	/**
	 * Gets the unique ID of this Thing. The ID is used by {@link IBNAModel#getThing(Object)}.
	 * 
	 * @return Thing ID.
	 */
	public Object getID();

	public void addThingListener(IThingListener thingListener);

	public void removeThingListener(IThingListener thingListener);

	public @Nullable
	<V> V get(IThingKey<V> key);

	public <V> V get(IThingKey<V> key, V valueIfNull);

	public boolean has(IThingKey<?> key);

	public <V> boolean has(IThingKey<V> key, @Nullable V value);

	public <V> V set(IThingKey<V> key, @Nullable V value);

	public @Nullable
	<V> V remove(IThingKey<V> key);

	public Set<Map.Entry<IThingKey<?>, ?>> entrySet();

	public boolean isShapeModifyingKey(IThingKey<?> key);

}