BasicDetails (SciJava Common 2.100.1 API)

All Superinterfaces:

Named

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
extends Named
```
An interface defining basic characteristics including name, label, description, and a table of key/value pairs.

Author:

Curtis Rueden

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`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.
`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.

Methods inherited from interface org.scijava.Named
getName, setName

- Method Detail
  - 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.
  - 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.