org.scijava.platform

Interface Platform

All Superinterfaces:

Disposable, SciJavaPlugin, SingletonPlugin

All Known Implementing Classes:

AbstractPlatform, DefaultPlatform

public interface Platform
extends SingletonPlugin, Disposable

An interface for configuring a specific deployment platform, defined by criteria such as operating system, machine architecture or Java version.

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

Author:

Curtis Rueden

See Also:

Plugin, PlatformService

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(PlatformService service) Activates and configures the platform.
boolean	isTarget() Determines whether the given platform is applicable to this runtime.
String	javaVendor() Java Runtime Environment vendor to match.
String	javaVersion() Minimum required Java Runtime Environment version.
void	open(URL url)
String	osArch() Operating system architecture to match.
String	osName() Operating system name to match.
String	osVersion() Minimum required operating system version.
boolean	registerAppMenus(Object menus) Informs the platform of a UI's newly created application menu structure.

Methods inherited from interface org.scijava.Disposable

dispose

Method Detail

javaVendor

String javaVendor()

Java Runtime Environment vendor to match.

javaVersion

String javaVersion()

Minimum required Java Runtime Environment version.

osArch

String osArch()

Operating system architecture to match.

osName

String osName()

Operating system name to match.

osVersion

String osVersion()

Minimum required operating system version.

isTarget

boolean isTarget()

Determines whether the given platform is applicable to this runtime.

configure

void configure(PlatformService service)

Activates and configures the platform.

open

void open(URL url)
          throws IOException

Throws:

IOException

registerAppMenus

boolean registerAppMenus(Object menus)

Informs the platform of a UI's newly created application menu structure. The platform may choose to do something platform-specific with the menus.

Parameters:

menus - The UI's newly created menu structure

Returns:

true iff the menus should not be added to the UI as normal because the platform did something platform-specific with them instead.