Package com.intellij.openapi.application.ex

Interface ApplicationEx

All Superinterfaces:

Application, AreaInstance, ComponentManager, Disposable, UserDataHolder

All Known Implementing Classes:

ApplicationImpl, MockApplication, MockApplicationEx

public interface ApplicationEx
extends Application

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields

Modifier and Type	Field and Description
static int	ELEVATE
static int	EXIT_CONFIRMED
static int	FORCE_EXIT
static java.lang.String	LOCATOR_FILE_NAME
static int	SAVE

Method Summary

Modifier and Type	Method and Description
void	assertIsDispatchThread(javax.swing.JComponent component)
void	assertTimeConsuming()
default void	doNotSave() Deprecated. use setSaveAllowed(boolean) with false
default void	executeByImpatientReader(java.lang.Runnable runnable) DO NOT USE
default void	exit() Exits the application, showing the exit confirmation prompt if it is enabled.
default void	exit(boolean force, boolean exitConfirmed)
default void	exit(int flags)
boolean	holdsReadLock()
default boolean	isInImpatientReader() DO NOT USE
boolean	isSaveAllowed()
boolean	isWriteActionInProgress()
boolean	isWriteActionPending()
default void	load()
void	load(java.lang.String configPath) Loads the application configuration from the specified path
default void	restart() Exits and restarts IDE.
void	restart(boolean exitConfirmed)
void	restart(boolean exitConfirmed, boolean elevate) Restarts the IDE with optional process elevation (on Windows).
boolean	runProcessWithProgressSynchronously(java.lang.Runnable process, java.lang.String progressTitle, boolean canBeCanceled, Project project) Runs modal process.
boolean	runProcessWithProgressSynchronously(java.lang.Runnable process, java.lang.String progressTitle, boolean canBeCanceled, Project project, javax.swing.JComponent parentComponent) Runs modal process.
boolean	runProcessWithProgressSynchronously(java.lang.Runnable process, java.lang.String progressTitle, boolean canBeCanceled, Project project, javax.swing.JComponent parentComponent, java.lang.String cancelText) Runs modal process.
boolean	runProcessWithProgressSynchronouslyInReadAction(Project project, java.lang.String progressTitle, boolean canBeCanceled, java.lang.String cancelText, javax.swing.JComponent parentComponent, java.lang.Runnable process) Executes process in a separate thread in the application thread pool (see Application.executeOnPooledThread(Runnable)).
default boolean	runWriteActionWithCancellableProgressInDispatchThread(java.lang.String title, Project project, javax.swing.JComponent parentComponent, Consumer<? super ProgressIndicator> action)
default boolean	runWriteActionWithNonCancellableProgressInDispatchThread(java.lang.String title, Project project, javax.swing.JComponent parentComponent, Consumer<? super ProgressIndicator> action)
void	setSaveAllowed(boolean value)
boolean	tryRunReadAction(java.lang.Runnable action) Tries to acquire the read lock and run the action

Methods inherited from interface com.intellij.openapi.application.Application

acquireReadActionLock, acquireWriteActionLock, acquireWriteIntentLockIfNeeded, addApplicationListener, addApplicationListener, assertIsDispatchThread, assertIsWriteThread, assertReadAccessAllowed, assertWriteAccessAllowed, executeOnPooledThread, executeOnPooledThread, exit, getAnyModalityState, getCurrentModalityState, getDefaultModalityState, getIdleTime, getInvokator, getModalityStateForComponent, getNoneModalityState, getStartTime, hasWriteAction, invokeAndWait, invokeAndWait, invokeLater, invokeLater, invokeLater, invokeLater, invokeLaterOnWriteThread, invokeLaterOnWriteThread, invokeLaterOnWriteThread, isActive, isCommandLine, isDispatchThread, isDisposeInProgress, isEAP, isHeadlessEnvironment, isInternal, isReadAccessAllowed, isRestartCapable, isUnitTestMode, isWriteAccessAllowed, isWriteThread, releaseWriteIntentLockIfNeeded, removeApplicationListener, runIntendedWriteActionOnCurrentThread, runReadAction, runReadAction, runReadAction, runUnlockingIntendedWrite, runWriteAction, runWriteAction, runWriteAction, saveAll, saveSettings

Methods inherited from interface com.intellij.openapi.components.ComponentManager

createError, createError, getComponent, getComponent, getComponent, getComponentInstancesOfType, getComponentInstancesOfType, getComponents, getDisposed, getExtensionArea, getExtensions, getMessageBus, getPicoContainer, getService, getService, getServiceIfCreated, hasComponent, instantiateClass, instantiateClassWithConstructorInjection, instantiateExtensionWithPicoContainerOnlyIfNeeded, isDisposed, isDisposedOrDisposeInProgress, logError

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Methods inherited from interface com.intellij.openapi.Disposable

dispose

Field Detail

LOCATOR_FILE_NAME

static final java.lang.String LOCATOR_FILE_NAME

See Also:

Constant Field Values

FORCE_EXIT

static final int FORCE_EXIT

See Also:

Constant Field Values

EXIT_CONFIRMED

static final int EXIT_CONFIRMED

See Also:

Constant Field Values

SAVE

static final int SAVE

See Also:

Constant Field Values

ELEVATE

static final int ELEVATE

See Also:

Constant Field Values

Method Detail

load

void load(java.lang.String configPath)

Loads the application configuration from the specified path

Parameters:

configPath - Path to /config folder

load

default void load()

holdsReadLock

boolean holdsReadLock()

Returns:

true if this thread is inside read action.

See Also:

Application.runReadAction(Runnable)

isWriteActionInProgress

boolean isWriteActionInProgress()

Returns:

true if the EDT is performing write action right now.

See Also:

Application.runWriteAction(Runnable)

isWriteActionPending

boolean isWriteActionPending()

Returns:

true if the EDT started to acquire write action but has not acquired it yet.

See Also:

Application.runWriteAction(Runnable)

isSaveAllowed

boolean isSaveAllowed()

setSaveAllowed

void setSaveAllowed(boolean value)

doNotSave

@Deprecated
default void doNotSave()

Deprecated. use setSaveAllowed(boolean) with false

runProcessWithProgressSynchronouslyInReadAction

boolean runProcessWithProgressSynchronouslyInReadAction(Project project,
                                                        java.lang.String progressTitle,
                                                        boolean canBeCanceled,
                                                        java.lang.String cancelText,
                                                        javax.swing.JComponent parentComponent,
                                                        java.lang.Runnable process)

Executes process in a separate thread in the application thread pool (see Application.executeOnPooledThread(Runnable)). The process is run inside read action (see Application.runReadAction(Runnable)) If run from EDT, it is guaranteed that no other read or write action is run before the process start running. If the process is running for too long, a progress window shown with progressTitle and a button with cancelText.

Returns:

true if process run successfully and was not canceled.

exit

default void exit(int flags)

exit

default void exit()

Description copied from interface: Application

Exits the application, showing the exit confirmation prompt if it is enabled.

Specified by:

exit in interface Application

exit

default void exit(boolean force,
                  boolean exitConfirmed)

Parameters:

force - if true, no additional confirmations will be shown. The application is guaranteed to exit

exitConfirmed - if true, suppresses any shutdown confirmation. However, if there are any background processes or tasks running, a corresponding confirmation will be shown with the possibility to cancel the operation

restart

void restart(boolean exitConfirmed)

Parameters:

exitConfirmed - if true, suppresses any shutdown confirmation. However, if there are any background processes or tasks running, a corresponding confirmation will be shown with the possibility to cancel the operation

restart

default void restart()

Description copied from interface: Application

Exits and restarts IDE. If the current platform is not restart capable, only exits.

Specified by:

restart in interface Application

restart

void restart(boolean exitConfirmed,
             boolean elevate)

Restarts the IDE with optional process elevation (on Windows).

Parameters:

exitConfirmed - if true, the IDE does not ask for exit confirmation.

elevate - if true and the IDE is running on Windows, the IDE is restarted in elevated mode (with admin privileges)

runProcessWithProgressSynchronously

boolean runProcessWithProgressSynchronously(java.lang.Runnable process,
                                            java.lang.String progressTitle,
                                            boolean canBeCanceled,
                                            Project project)

Runs modal process. For internal use only, see Task

runProcessWithProgressSynchronously

boolean runProcessWithProgressSynchronously(java.lang.Runnable process,
                                            java.lang.String progressTitle,
                                            boolean canBeCanceled,
                                            Project project,
                                            javax.swing.JComponent parentComponent)

Runs modal process. For internal use only, see Task

runProcessWithProgressSynchronously

boolean runProcessWithProgressSynchronously(java.lang.Runnable process,
                                            java.lang.String progressTitle,
                                            boolean canBeCanceled,
                                            Project project,
                                            javax.swing.JComponent parentComponent,
                                            java.lang.String cancelText)

Runs modal process. For internal use only, see Task

assertIsDispatchThread

void assertIsDispatchThread(javax.swing.JComponent component)

assertTimeConsuming

void assertTimeConsuming()

tryRunReadAction

boolean tryRunReadAction(java.lang.Runnable action)

Tries to acquire the read lock and run the action

Returns:

true if action was run while holding the lock, false if was unable to get the lock and action was not run

executeByImpatientReader

default void executeByImpatientReader(java.lang.Runnable runnable)
                               throws ApplicationUtil.CannotRunReadActionException

DO NOT USE

Throws:

ApplicationUtil.CannotRunReadActionException

runWriteActionWithCancellableProgressInDispatchThread

default boolean runWriteActionWithCancellableProgressInDispatchThread(java.lang.String title,
                                                                      Project project,
                                                                      javax.swing.JComponent parentComponent,
                                                                      Consumer<? super ProgressIndicator> action)

runWriteActionWithNonCancellableProgressInDispatchThread

default boolean runWriteActionWithNonCancellableProgressInDispatchThread(java.lang.String title,
                                                                         Project project,
                                                                         javax.swing.JComponent parentComponent,
                                                                         Consumer<? super ProgressIndicator> action)

isInImpatientReader

default boolean isInImpatientReader()

DO NOT USE