Package com.intellij.execution

Class ExecutableValidator

java.lang.Object

com.intellij.execution.ExecutableValidator

Direct Known Subclasses:

GitExecutableValidator, HgExecutableValidator, SvnExecutableChecker

public abstract class ExecutableValidator
extends java.lang.Object

Validates the given external executable. If it is not valid, shows notification to fix it. Notification group is registered as a NotificationDisplayType.STICKY_BALLOON by default.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ExecutableValidator.ExecutableNotValidNotification

Field Summary

Fields

Modifier and Type	Field and Description
protected Project	myProject
static int	TIMEOUT_MS

Constructor Summary

Constructors

Constructor and Description
ExecutableValidator(Project project, java.lang.String notificationErrorTitle, java.lang.String notificationErrorDescription) Configures notification and dialog by setting text messages and titles specific to the whoever uses the validator.

Method Summary

Modifier and Type	Method and Description
boolean	checkExecutableAndNotifyIfNeeded() Checks if executable is valid and displays the notification if not.
boolean	checkExecutableAndShowMessageIfNeeded(java.awt.Component parentComponent) Checks if executable is valid and shows the message if not.
protected ExecutableValidator.ExecutableNotValidNotification	createDefaultNotification()
protected static boolean	doCheckExecutable(java.lang.String executable, java.util.List<java.lang.String> processParameters, java.util.Map<java.lang.String,java.lang.String> envVariables)
protected abstract java.lang.String	getConfigurableDisplayName()
protected abstract java.lang.String	getCurrentExecutable()
boolean	isExecutableValid()
protected boolean	isExecutableValid(java.lang.String executable) Returns true if the supplied executable is valid.
protected boolean	notify(Notification notification)
protected java.lang.String	prepareDescription(java.lang.String description, boolean appendFixIt)
protected void	showSettings()
protected void	showSettingsAndExpireIfFixed(Notification notification)
protected Notification	validate(java.lang.String executable)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TIMEOUT_MS

public static final int TIMEOUT_MS

myProject

protected final Project myProject

Constructor Detail

ExecutableValidator

public ExecutableValidator(Project project,
                           java.lang.String notificationErrorTitle,
                           java.lang.String notificationErrorDescription)

Configures notification and dialog by setting text messages and titles specific to the whoever uses the validator.

Parameters:

notificationErrorTitle - title of the notification about not valid executable.

notificationErrorDescription - description of this notification with a link to fix it (link action is defined by showSettingsAndExpireIfFixed(com.intellij.notification.Notification)

Method Detail

getCurrentExecutable

protected abstract java.lang.String getCurrentExecutable()

getConfigurableDisplayName

protected abstract java.lang.String getConfigurableDisplayName()

Returns:

the settings configurable display name, where the executable is shown and can be fixed. This configurable will be opened if user presses "Fix" on the notification about invalid executable.

validate

protected Notification validate(java.lang.String executable)

createDefaultNotification

protected ExecutableValidator.ExecutableNotValidNotification createDefaultNotification()

isExecutableValid

protected boolean isExecutableValid(java.lang.String executable)

Returns true if the supplied executable is valid. Default implementation: try to execute the given executable and test if output returned errors. This can take a long time since it spawns external process.

Parameters:

executable - Path to executable.

Returns:

true if process with the supplied executable completed without errors and with exit code 0.

doCheckExecutable

protected static boolean doCheckExecutable(java.lang.String executable,
                                           java.util.List<java.lang.String> processParameters,
                                           java.util.Map<java.lang.String,java.lang.String> envVariables)

prepareDescription

protected java.lang.String prepareDescription(java.lang.String description,
                                              boolean appendFixIt)

showSettingsAndExpireIfFixed

protected void showSettingsAndExpireIfFixed(Notification notification)

showSettings

protected void showSettings()

checkExecutableAndNotifyIfNeeded

public boolean checkExecutableAndNotifyIfNeeded()

Checks if executable is valid and displays the notification if not.

Returns:

true if executable was valid, false - if not valid (and notification was shown in that case).

See Also:

checkExecutableAndShowMessageIfNeeded(java.awt.Component)

notify

protected boolean notify(Notification notification)

checkExecutableAndShowMessageIfNeeded

public boolean checkExecutableAndShowMessageIfNeeded(java.awt.Component parentComponent)

Checks if executable is valid and shows the message if not. This method is to be used instead of checkExecutableAndNotifyIfNeeded() when Git fails to start from a modal dialog: in that case user won't be able to click "Fix it".

Returns:

true if executable was valid, false - if not valid (and a message is shown in that case).

See Also:

checkExecutableAndNotifyIfNeeded()

isExecutableValid

public boolean isExecutableValid()