org.scijava
Interface BasicDetails

All Known Subinterfaces:

ModuleInfo, ModuleItem<T>, MutableModuleInfo, MutableModuleItem<T>, UIDetails

All Known Implementing Classes:

AbstractBasicDetails, AbstractModuleInfo, AbstractModuleItem, AbstractUIDetails, CommandInfo, CommandModuleItem, DefaultMutableModuleInfo, DefaultMutableModuleItem, DynamicCommandInfo, PluginInfo, ScriptInfo

public interface BasicDetails

An interface defining basic characteristics including name, label, description, and a table of key/value pairs.

Author:

Curtis Rueden

Method Summary

String	get(String key) Gets the value of the given key, or null if undefined.
String	getDescription() Gets a string describing the object.
String	getLabel() Gets the name to appear in a UI, if applicable.
String	getName() Gets the unique name of the object.
boolean	is(String key) Returns true iff the given key is defined.
void	set(String key, String value) Sets the value of the given key.
void	setDescription(String description) Sets a string describing the object.
void	setLabel(String label) Sets the name to appear in a UI, if applicable.
void	setName(String name) Sets the unique name of the object.

Method Detail

getName

String getName()

Gets the unique name of the object.

getLabel

String getLabel()

Gets the name to appear in a UI, if applicable.

getDescription

String getDescription()

Gets a string describing the object.

is

boolean is(String key)

Returns true iff the given key is defined.

get

String get(String key)

Gets the value of the given key, or null if undefined.

setName

void setName(String name)

Sets the unique name of the object.

setLabel

void setLabel(String label)

Sets the name to appear in a UI, if applicable.

setDescription

void setDescription(String description)

Sets a string describing the object.

set

void set(String key,
         String value)

Sets the value of the given key.