Package org.scijava.service

Interface Service

All Superinterfaces:

Comparable<Prioritized>, Contextual, Disposable, HasPluginInfo, Identifiable, Initializable, Locatable, Logged, Prioritized, RichPlugin, SciJavaPlugin, Versioned

All Known Subinterfaces:

AppEventService, AppService, CacheService, CommandService, ConsoleService, ConvertService, DataHandleService, DisplayService, DownloadService, DragAndDropService, EventHistory, EventService, HandlerService<DT,PT>, IconService, InputService, IOService, LocationService, LogService, MainService, MenuService, ModuleService, NIOService, ObjectService, OptionsService, ParseService, PlatformService, PluginService, PrefService, PTService<PT>, RecentFileService, RunService, SciJavaService, ScriptHeaderService, ScriptProcessorService, ScriptService, SingletonService<PT>, StartupService, StatusService, TaskService, TextIOService, TextService, ThreadService, ToolService, TypedIOService<D>, TypedService<DT,PT>, UIService, WelcomeService, WidgetService, WrapperService<DT,PT>

All Known Implementing Classes:

AbstractConvertService, AbstractHandlerService, AbstractLogService, AbstractPrefService, AbstractPTService, AbstractService, AbstractSingletonService, AbstractTypedIOService, AbstractTypedService, AbstractWrapperService, DefaultAppEventService, DefaultAppService, DefaultCacheService, DefaultCommandService, DefaultConsoleService, DefaultConvertService, DefaultDataHandleService, DefaultDisplayService, DefaultDownloadService, DefaultDragAndDropService, DefaultEventHistory, DefaultEventService, DefaultInputService, DefaultIOService, DefaultLocationService, DefaultMainService, DefaultMenuService, DefaultModuleService, DefaultNIOService, DefaultObjectService, DefaultOptionsService, DefaultParseService, DefaultPlatformService, DefaultPluginService, DefaultPrefService, DefaultRecentFileService, DefaultRunService, DefaultScriptHeaderService, DefaultScriptProcessorService, DefaultScriptService, DefaultStartupService, DefaultStatusService, DefaultTaskService, DefaultTextIOService, DefaultTextService, DefaultThreadService, DefaultToolService, DefaultUIService, DefaultWelcomeService, DefaultWidgetService, StderrLogService

public interface Service
extends RichPlugin, Initializable, Disposable

A SciJava service, for a particular area of functionality.

Services discoverable at runtime must implement this interface and be annotated with @Plugin with attribute Plugin.type() = Service.class. While it possible to create a service merely by implementing this interface, it is encouraged to instead extend AbstractService, for convenience.

Author:

Curtis Rueden

See Also:

Plugin

Method Summary

Modifier and Type	Method	Description
default void	initialize()	Performs any needed initialization when the service is first loaded.
default void	registerEventHandlers()	Registers the service's event handler methods.

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Disposable

dispose

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

Methods inherited from interface org.scijava.Versioned

getVersion

Method Detail

registerEventHandlers

default void registerEventHandlers()

Registers the service's event handler methods.

NB: This method is not intended to be called directly. It is called by the service framework itself (specifically by the ServiceHelper) when initializing the service. It should not be called a second time.

initialize

default void initialize()

Performs any needed initialization when the service is first loaded.

NB: This method is not intended to be called directly. It is called by the service framework itself (specifically by the ServiceHelper) when initializing the service. It should not be called a second time.

Specified by:

initialize in interface Initializable