org.scijava.platform.PlatformService Maven / Gradle / Ivy

Go to download
/*
 * #%L
 * SciJava Common shared library for SciJava software.
 * %%
 * Copyright (C) 2009 - 2017 Board of Regents of the University of
 * Wisconsin-Madison, Broad Institute of MIT and Harvard, Max Planck
 * Institute of Molecular Cell Biology and Genetics, University of
 * Konstanz, and KNIME GmbH.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * #L%
 */

package org.scijava.platform;

import java.io.IOException;
import java.net.URL;
import java.util.List;

import org.scijava.app.App;
import org.scijava.app.AppService;
import org.scijava.command.CommandService;
import org.scijava.event.EventService;
import org.scijava.plugin.SingletonService;
import org.scijava.service.SciJavaService;

/**
 * Interface for service that handles platform-specific deployment issues. A
 * "platform" can be an operating system, CPU architecture, or version of Java.
 * 
 * @author Curtis Rueden
 */
public interface PlatformService extends SingletonService,
	SciJavaService
{

	default EventService eventService() {
		return context().getService(EventService.class);
	}

	default CommandService commandService() {
		return context().getService(CommandService.class);
	}

	/** Gets the platform handlers applicable to this platform. */
	List getTargetPlatforms();

	/**
	 * Opens a URL in a platform-dependent way. Typically the URL is opened in an
	 * external web browser instance, but the behavior is ultimately defined by
	 * the available platform handler implementations.
	 */
	void open(URL url) throws IOException;

	/**
	 * Executes a native program and waits for it to return.
	 * 
	 * @return the exit code of the execution.
	 */
	int exec(String... args) throws IOException;

	/**
	 * Informs the active platform handlers of a UI's newly created application
	 * menu structure. Each active platform handler may choose to do something
	 * platform-specific with the menus.
	 * 
	 * @param menus The UI's newly created menu structure
	 * @return true iff the menus should not be added to the UI as normal because
	 *         a platform handler did something platform-specific with them
	 *         instead.
	 */
	boolean registerAppMenus(Object menus);

	// -- Deprecated methods --

	/** @deprecated Use {@link AppService} and {@link App} instead. */
	@Deprecated
	AppEventService getAppEventService();

	/** @deprecated Use {@link #eventService()} instead. */
	@Deprecated
	default EventService getEventService() {
		return eventService();
	}

	/** @deprecated Use {@link #commandService()} instead. */
	@Deprecated
	default CommandService getCommandService() {
		return commandService();
	}
}