Package org.scijava

Class AbstractGateway

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

org.scijava.AbstractGateway

All Implemented Interfaces:

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

Direct Known Subclasses:

SciJava

public abstract class AbstractGateway
extends AbstractRichPlugin
implements Gateway

Abstract superclass for Gateway implementations.

Author:

Mark Hiner, Curtis Rueden

Constructor Summary

Constructors

Constructor	Description
AbstractGateway()
AbstractGateway(String appName, Context context)

Method Summary

Modifier and Type	Method	Description
AppService	app()	Gets this application context's AppService.
AppEventService	appEvent()	Gets this application context's AppEventService.
CommandService	command()	Gets this application context's CommandService.
ConsoleService	console()	Gets this application context's ConsoleService.
ConvertService	convert()
DisplayService	display()	Gets this application context's DisplayService.
EventService	event()	Gets this application context's EventService.
EventHistory	eventHistory()	Gets this application context's EventHistory.
<S extends Service> S	get(Class<S> serviceClass)	Returns an implementation of the requested Service, if it exists in the underlying Context.
Service	get(String serviceClassName)	Returns an implementation of the Service with the given class name, if it exists in the underlying Context.
App	getApp()
String	getInfo(boolean mem)
String	getShortName()	Gets a very succinct name for use referring to this gateway, e.g. as a variable name for scripting.
String	getTitle()
String	getVersion()	Gets the version of the object.
IconService	icon()	Gets this application context's IconService.
InputService	input()	Gets this application context's InputService.
IOService	io()	Gets this application context's IOService.
void	launch(String... args)	Perform launch operations associated with this gateway.
LocationService	location()	Gets this application context's LocationService.
LogService	log()	Gets this application context's LogService.
MainService	main()	Gets this application context's MainService.
MenuService	menu()	Gets this application context's MenuService.
ModuleService	module()	Gets this application context's ModuleService.
ObjectService	object()	Gets this application context's ObjectService.
OptionsService	options()	Gets this application context's OptionsService.
PlatformService	platform()	Gets this application context's PlatformService.
PluginService	plugin()	Gets this application context's PluginService.
PrefService	prefs()
RecentFileService	recentFile()	Gets this application context's RecentFileService.
ScriptService	script()	Gets this application context's ScriptService.
StartupService	startup()	Gets this application context's StartupService.
StatusService	status()	Gets this application context's StatusService.
TextService	text()	Gets this application context's TextService.
ThreadService	thread()	Gets this application context's ThreadService.
ToolService	tool()	Gets this application context's ToolService.
UIService	ui()	Gets this application context's UIService.
WidgetService	widget()	Gets this application context's WidgetService.

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

getInfo, getPriority, setInfo, setPriority, toString

Methods inherited from class org.scijava.AbstractContextual

context, getContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Gateway

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

Constructor Detail

AbstractGateway

public AbstractGateway()

AbstractGateway

public AbstractGateway(String appName,
                       Context context)

Method Detail

launch

public void launch(String... args)

Description copied from interface: Gateway

Perform launch operations associated with this gateway.

Typical operations might include:

• Handle the given command line arguments using the ConsoleService.
• Execute registered main classes of the MainService.
• Display the default user interface using the UIService.
• In some circumstances (e.g., when running headless), dispose the context after launch operations are complete.

Specified by:

launch in interface Gateway

Parameters:

args - The arguments to pass to the application.

getShortName

public String getShortName()

Description copied from interface: Gateway

Gets a very succinct name for use referring to this gateway, e.g. as a variable name for scripting.

Specified by:

getShortName in interface Gateway

get

public <S extends Service> S get(Class<S> serviceClass)

Description copied from interface: Gateway

Returns an implementation of the requested Service, if it exists in the underlying Context.

Specified by:

get in interface Gateway

Parameters:

serviceClass - the requested Service

Returns:

The singleton instance of the given class

get

public Service get(String serviceClassName)

Description copied from interface: Gateway

Returns an implementation of the Service with the given class name, if it exists in the underlying Context.

Specified by:

get in interface Gateway

Parameters:

serviceClassName - name of the requested Service

Returns:

The singleton instance of the requested Service

appEvent

public AppEventService appEvent()

Description copied from interface: Gateway

Gets this application context's AppEventService.

Specified by:

appEvent in interface Gateway

Returns:

The AppEventService of this application context.

app

public AppService app()

Description copied from interface: Gateway

Gets this application context's AppService.

Specified by:

app in interface Gateway

Returns:

The AppService of this application context.

command

public CommandService command()

Description copied from interface: Gateway

Gets this application context's CommandService.

Specified by:

command in interface Gateway

Returns:

The CommandService of this application context.

console

public ConsoleService console()

Description copied from interface: Gateway

Gets this application context's ConsoleService.

Specified by:

console in interface Gateway

Returns:

The ConsoleService of this application context.

convert

public ConvertService convert()

display

public DisplayService display()

Description copied from interface: Gateway

Gets this application context's DisplayService.

Specified by:

display in interface Gateway

Returns:

The DisplayService of this application context.

eventHistory

public EventHistory eventHistory()

Description copied from interface: Gateway

Gets this application context's EventHistory.

Specified by:

eventHistory in interface Gateway

Returns:

The EventHistory of this application context.

event

public EventService event()

Description copied from interface: Gateway

Gets this application context's EventService.

Specified by:

event in interface Gateway

Returns:

The EventService of this application context.

icon

public IconService icon()

Description copied from interface: Gateway

Gets this application context's IconService.

Specified by:

icon in interface Gateway

Returns:

The IconService of this application context.

input

public InputService input()

Description copied from interface: Gateway

Gets this application context's InputService.

Specified by:

input in interface Gateway

Returns:

The InputService of this application context.

io

public IOService io()

Description copied from interface: Gateway

Gets this application context's IOService.

Specified by:

io in interface Gateway

Returns:

The IOService of this application context.

location

public LocationService location()

Description copied from interface: Gateway

Gets this application context's LocationService.

Specified by:

location in interface Gateway

Returns:

The LocationService of this application context.

log

public LogService log()

Description copied from interface: Gateway

Gets this application context's LogService.

Specified by:

log in interface Gateway

Specified by:

log in interface Logged

Specified by:

log in interface RichPlugin

Returns:

The LogService of this application context.

main

public MainService main()

Description copied from interface: Gateway

Gets this application context's MainService.

Specified by:

main in interface Gateway

Returns:

The MainService of this application context.

menu

public MenuService menu()

Description copied from interface: Gateway

Gets this application context's MenuService.

Specified by:

menu in interface Gateway

Returns:

The MenuService of this application context.

module

public ModuleService module()

Description copied from interface: Gateway

Gets this application context's ModuleService.

Specified by:

module in interface Gateway

Returns:

The ModuleService of this application context.

object

public ObjectService object()

Description copied from interface: Gateway

Gets this application context's ObjectService.

Specified by:

object in interface Gateway

Returns:

The ObjectService of this application context.

options

public OptionsService options()

Description copied from interface: Gateway

Gets this application context's OptionsService.

Specified by:

options in interface Gateway

Returns:

The OptionsService of this application context.

platform

public PlatformService platform()

Description copied from interface: Gateway

Gets this application context's PlatformService.

Specified by:

platform in interface Gateway

Returns:

The PlatformService of this application context.

plugin

public PluginService plugin()

Description copied from interface: Gateway

Gets this application context's PluginService.

Specified by:

plugin in interface Gateway

Returns:

The PluginService of this application context.

prefs

public PrefService prefs()

recentFile

public RecentFileService recentFile()

Description copied from interface: Gateway

Gets this application context's RecentFileService.

Specified by:

recentFile in interface Gateway

Returns:

The RecentFileService of this application context.

script

public ScriptService script()

Description copied from interface: Gateway

Gets this application context's ScriptService.

Specified by:

script in interface Gateway

Returns:

The ScriptService of this application context.

startup

public StartupService startup()

Description copied from interface: Gateway

Gets this application context's StartupService.

Specified by:

startup in interface Gateway

Returns:

The StartupService of this application context.

status

public StatusService status()

Description copied from interface: Gateway

Gets this application context's StatusService.

Specified by:

status in interface Gateway

Returns:

The StatusService of this application context.

text

public TextService text()

Description copied from interface: Gateway

Gets this application context's TextService.

Specified by:

text in interface Gateway

Returns:

The TextService of this application context.

thread

public ThreadService thread()

Description copied from interface: Gateway

Gets this application context's ThreadService.

Specified by:

thread in interface Gateway

Returns:

The ThreadService of this application context.

tool

public ToolService tool()

Description copied from interface: Gateway

Gets this application context's ToolService.

Specified by:

tool in interface Gateway

Returns:

The ToolService of this application context.

ui

public UIService ui()

Description copied from interface: Gateway

Gets this application context's UIService.

Specified by:

ui in interface Gateway

Returns:

The UIService of this application context.

widget

public WidgetService widget()

Description copied from interface: Gateway

Gets this application context's WidgetService.

Specified by:

widget in interface Gateway

Returns:

The WidgetService of this application context.

getApp

public App getApp()

Specified by:

getApp in interface Gateway

See Also:

AppService

getTitle

public String getTitle()

Specified by:

getTitle in interface Gateway

See Also:

App.getTitle()

getInfo

public String getInfo(boolean mem)

Specified by:

getInfo in interface Gateway

See Also:

App.getInfo(boolean)

getVersion

public String getVersion()

Description copied from interface: Versioned

Gets the version of the object.

Specified by:

getVersion in interface Versioned