Gateway (SciJava Common 2.100.0 API)

All Superinterfaces:

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

All Known Implementing Classes:

AbstractGateway, SciJava
```
public interface Gateway
extends RichPlugin, Disposable
```
Interface for convenience classes that wrap a Context to provide one-line access to a suite of Services.
The get(java.lang.Class<S>) methods provide consistent Service instantiation, while throwing NoSuchServiceException if the requested Service is not found.

Sample implementation

Let's say we have a Kraken service and a Cow service. Using the Context directly, the code would look like:
```
 Context context = new Context();
 context.getService(Cow.class).feedToKraken();
 context.getService(Kraken.class).burp();
```
To perform these actions, you have to know a priori to ask for a Cow and a Kraken; i.e., your IDE's code completion will not give you a hint. Further, if either service is unavailable, a NullPointerException is thrown.

But if we create a Gateway class called Animals with the following signatures:
```
 public Cow cow() { return get(Cow.class); }
 public Kraken kraken() { return get(Kraken.class); }
```
We can now access our services through the new Animals gateway:
```
 Animals animals = new Animals();
 animals.cow().feedToKraken();
 animals.kraken().burp();
```
This provides succinct yet explicit access to the Cow and Kraken services; it is a simple two-layer access to functionality, which an IDE can auto-complete. And if one of the services is not available, a NoSuchServiceException is thrown, which facilitates appropriate (but optional) handling of missing services.

Gateways discoverable at runtime must implement this interface and be annotated with @Gateway with attribute Plugin.type() = Gateway.class. While it possible to create a gateway merely by implementing this interface, it is encouraged to instead extend AbstractGateway, for convenience.
Author:

Mark Hiner, Curtis Rueden

See Also:

Context

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and 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`.
`DisplayService`	`display()` Gets this application context's `DisplayService`.
`default void`	`dispose()` Performs any needed cleanup of the object's services, in preparation for the object being retired (e.g., to make garbage collection possible).
`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()`
`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`.
`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 interface org.scijava.plugin.RichPlugin
getIdentifier

Methods inherited from interface org.scijava.Contextual
context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized
compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo
getInfo, setInfo

Methods inherited from interface org.scijava.Locatable
getLocation

Methods inherited from interface org.scijava.Versioned
getVersion

- Method Detail
  - launch
```
void launch(String... args)
```
    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.
    Parameters:
    
    args - The arguments to pass to the application.
  - getShortName
```
String getShortName()
```
    Gets a very succinct name for use referring to this gateway, e.g. as a variable name for scripting.
  - get
```
<S extends Service> S get(Class<S> serviceClass)
```
    Returns an implementation of the requested Service, if it exists in the underlying Context.
    
    Parameters:
    
    serviceClass - the requested Service
    
    Returns:
    
    The singleton instance of the given class
    
    Throws:
    
    NullContextException - if the application context is not set.
    
    NoSuchServiceException - if there is no service of the given class.
  - get
```
Service get(String serviceClassName)
```
    Returns an implementation of the Service with the given class name, if it exists in the underlying Context.
    
    Parameters:
    
    serviceClassName - name of the requested Service
    
    Returns:
    
    The singleton instance of the requested Service
    
    Throws:
    
    NullContextException - if the application context is not set.
    
    NoSuchServiceException - if there is no service matching serviceClassName.
  - appEvent
```
AppEventService appEvent()
```
    Gets this application context's AppEventService.
    
    Returns:
    
    The AppEventService of this application context.
  - app
```
AppService app()
```
    Gets this application context's AppService.
    
    Returns:
    
    The AppService of this application context.
  - command
```
CommandService command()
```
    Gets this application context's CommandService.
    
    Returns:
    
    The CommandService of this application context.
  - console
```
ConsoleService console()
```
    Gets this application context's ConsoleService.
    
    Returns:
    
    The ConsoleService of this application context.
  - display
```
DisplayService display()
```
    Gets this application context's DisplayService.
    
    Returns:
    
    The DisplayService of this application context.
  - eventHistory
```
EventHistory eventHistory()
```
    Gets this application context's EventHistory.
    
    Returns:
    
    The EventHistory of this application context.
  - event
```
EventService event()
```
    Gets this application context's EventService.
    
    Returns:
    
    The EventService of this application context.
  - icon
```
IconService icon()
```
    Gets this application context's IconService.
    
    Returns:
    
    The IconService of this application context.
  - input
```
InputService input()
```
    Gets this application context's InputService.
    
    Returns:
    
    The InputService of this application context.
  - io
```
IOService io()
```
    Gets this application context's IOService.
    
    Returns:
    
    The IOService of this application context.
  - location
```
LocationService location()
```
    Gets this application context's LocationService.
    
    Returns:
    
    The LocationService of this application context.
  - log
```
LogService log()
```
    Gets this application context's LogService.
    
    Specified by:
    
    log in interface Logged
    
    Specified by:
    
    log in interface RichPlugin
    
    Returns:
    
    The LogService of this application context.
  - main
```
MainService main()
```
    Gets this application context's MainService.
    
    Returns:
    
    The MainService of this application context.
  - menu
```
MenuService menu()
```
    Gets this application context's MenuService.
    
    Returns:
    
    The MenuService of this application context.
  - module
```
ModuleService module()
```
    Gets this application context's ModuleService.
    
    Returns:
    
    The ModuleService of this application context.
  - object
```
ObjectService object()
```
    Gets this application context's ObjectService.
    
    Returns:
    
    The ObjectService of this application context.
  - options
```
OptionsService options()
```
    Gets this application context's OptionsService.
    
    Returns:
    
    The OptionsService of this application context.
  - platform
```
PlatformService platform()
```
    Gets this application context's PlatformService.
    
    Returns:
    
    The PlatformService of this application context.
  - plugin
```
PluginService plugin()
```
    Gets this application context's PluginService.
    
    Returns:
    
    The PluginService of this application context.
  - recentFile
```
RecentFileService recentFile()
```
    Gets this application context's RecentFileService.
    
    Returns:
    
    The RecentFileService of this application context.
  - script
```
ScriptService script()
```
    Gets this application context's ScriptService.
    
    Returns:
    
    The ScriptService of this application context.
  - startup
```
StartupService startup()
```
    Gets this application context's StartupService.
    
    Returns:
    
    The StartupService of this application context.
  - status
```
StatusService status()
```
    Gets this application context's StatusService.
    
    Returns:
    
    The StatusService of this application context.
  - text
```
TextService text()
```
    Gets this application context's TextService.
    
    Returns:
    
    The TextService of this application context.
  - thread
```
ThreadService thread()
```
    Gets this application context's ThreadService.
    
    Returns:
    
    The ThreadService of this application context.
  - tool
```
ToolService tool()
```
    Gets this application context's ToolService.
    
    Returns:
    
    The ToolService of this application context.
  - ui
```
UIService ui()
```
    Gets this application context's UIService.
    
    Returns:
    
    The UIService of this application context.
  - widget
```
WidgetService widget()
```
    Gets this application context's WidgetService.
    
    Returns:
    
    The WidgetService of this application context.
  - getApp
```
App getApp()
```
    See Also:
    
    AppService
  - getTitle
```
String getTitle()
```
    See Also:
    
    App.getTitle()
  - getInfo
```
String getInfo(boolean mem)
```
    See Also:
    
    App.getInfo(boolean)
  - dispose
```
default void dispose()
```
    Description copied from interface: Disposable
    
    Performs any needed cleanup of the object's services, in preparation for the object being retired (e.g., to make garbage collection possible).
    
    Specified by:
    
    dispose in interface Disposable

Interface Gateway

Sample implementation

Method Summary

Methods inherited from interface org.scijava.plugin.RichPlugin

Methods inherited from interface org.scijava.Contextual

Methods inherited from interface org.scijava.Prioritized

Methods inherited from interface org.scijava.plugin.HasPluginInfo

Methods inherited from interface org.scijava.Locatable

Methods inherited from interface org.scijava.Versioned

Method Detail

launch

getShortName

get

get

appEvent

app

command

console

display

eventHistory

event

icon

input

io

location

log

main

menu

module

object

options

platform

plugin

recentFile

script

startup

status

text

thread

tool

ui

widget

getApp

getTitle

getInfo

dispose