Package com.intellij.openapi.application

Interface ApplicationStarter

All Known Implementing Classes:

AbstractInspectionToolStarter, ApplicationStarterBase, ApplicationStarterEx, DiffApplicationBase, FormatterStarter, InspectionDump, InspectionMain, IntentionDump, KeymapGenerator, ShowProductVersion, TraverseUIStarter, UpdatePluginsApp

public interface ApplicationStarter

This extension point allows running custom [command-line] application based on IntelliJ platform.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANY_MODALITY
static ExtensionPointName<ApplicationStarter>	EP_NAME
static int	NON_MODAL
static int	NOT_IN_EDT

Method Summary

Modifier and Type	Method and Description
default boolean	allowAnyModalityState() Deprecated. Use getRequiredModality().
default boolean	canProcessExternalCommandLine() Applications that are capable of processing command-line arguments within a running IDE instance should return true from this method and implement processExternalCommandLineAsync(java.util.List<java.lang.String>, java.lang.String).
java.lang.String	getCommandName() Command-line switch to start with this runner.
default int	getRequiredModality() If true, the command of this launcher can be processed when there is a modal dialog open.
default boolean	isHeadless() Applications that are incapable of working in a headless mode should override the method and return false.
default void	main(java.util.List<java.lang.String> args) Called when application has been initialized.
default void	main(java.lang.String [] args) Deprecated. Use main(List)
default void	premain(java.util.List<java.lang.String> args) Called before application initialization.
default void	premain(java.lang.String [] args) Deprecated. Use premain(List)
default java.util.concurrent.Future<CliResult>	processExternalCommandLineAsync(java.util.List<java.lang.String> args, java.lang.String currentDirectory)

Field Detail

EP_NAME

static final ExtensionPointName<ApplicationStarter> EP_NAME

NON_MODAL

static final int NON_MODAL

See Also:

Constant Field Values

ANY_MODALITY

static final int ANY_MODALITY

See Also:

Constant Field Values

NOT_IN_EDT

static final int NOT_IN_EDT

See Also:

Constant Field Values

Method Detail

getCommandName

java.lang.String getCommandName()

Command-line switch to start with this runner. For example return "inspect" if you'd like to start an app with "idea.exe inspect ..." command).

Returns:

command-line selector.

premain

@Deprecated
default void premain(java.lang.String [] args)

Deprecated. Use premain(List)

premain

default void premain(java.util.List<java.lang.String> args)

Called before application initialization.

Parameters:

args - program arguments (including the selector)

main

@Deprecated
default void main(java.lang.String [] args)

Deprecated. Use main(List)

main

default void main(java.util.List<java.lang.String> args)

Called when application has been initialized. Invoked in event dispatch thread.

An application starter should take care of terminating JVM when appropriate by calling System.exit(int).

Parameters:

args - program arguments (including the selector)

isHeadless

default boolean isHeadless()

Applications that are incapable of working in a headless mode should override the method and return false.

canProcessExternalCommandLine

default boolean canProcessExternalCommandLine()

Applications that are capable of processing command-line arguments within a running IDE instance should return true from this method and implement processExternalCommandLineAsync(java.util.List<java.lang.String>, java.lang.String).

See Also:

processExternalCommandLineAsync(java.util.List<java.lang.String>, java.lang.String)

getRequiredModality

default int getRequiredModality()

If true, the command of this launcher can be processed when there is a modal dialog open. Such a starter may not directly change the PSI/VFS/project model of the opened projects or open new projects. Such activities should be performed inside write-safe contexts (see TransactionGuard).

allowAnyModalityState

@Deprecated
default boolean allowAnyModalityState()

Deprecated. Use getRequiredModality().

processExternalCommandLineAsync

default java.util.concurrent.Future<CliResult> processExternalCommandLineAsync(java.util.List<java.lang.String> args,
                                                                               java.lang.String currentDirectory)

See Also:

canProcessExternalCommandLine()