Package com.install4j.api.events
Enum EventType
- java.lang.Object
-
- java.lang.Enum<EventType>
-
- com.install4j.api.events.EventType
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<EventType>
public enum EventType extends java.lang.Enum<EventType>
Enumeration class that represents all different event types for instances ofInstallerEvent
. Installer events cover everything that is written to the installer log file as well as application life-cycle events.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description AFTER_DOWNLOAD
Fired before a file has been downloaded.AFTER_EXECUTE_ACTION
Fired after an action has been executed.AFTER_INSTALL_FILE
Fired after a file has been installed.AFTER_ROLLBACK_ACTION
Fired after a rollback is performedBEFORE_DOWNLOAD
Fired before a file is downloaded.BEFORE_EXECUTE_ACTION
Fired before an action is executedBEFORE_INSTALL_FILE
Fired before a file is installed.BEFORE_ROLLBACK_ACTION
Fired before a rollback is performedCANCELED
Fired just before the installer or uninstaller quits after having been cancelled.CANCELLING
Fired when the installer or uninstaller is cancelled but before any cleanup has been performed.DIRECTORY_CREATED
Fired after a directory has been installed.FILE_INSTALLATION_STARTED
Fired before the file installation is started by the "Install files" action.FINISHED
Fired just before the installer or uninstaller quits.FINISHING
Fired when the installer or uninstaller quits but before any cleanup has been performed.SHOW_SCREEN
Fired before a screen is shown.VARIABLE_CHANGED
Fired after a variable has been set.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getOperationVerbose()
Get a verbose message that describes the operation that is connected with this event.java.lang.String
toString()
static EventType
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static EventType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
BEFORE_EXECUTE_ACTION
public static final EventType BEFORE_EXECUTE_ACTION
Fired before an action is executed
-
AFTER_EXECUTE_ACTION
public static final EventType AFTER_EXECUTE_ACTION
Fired after an action has been executed. The event object will be of typeInstallerActionEvent
.
-
BEFORE_ROLLBACK_ACTION
public static final EventType BEFORE_ROLLBACK_ACTION
Fired before a rollback is performed
-
AFTER_ROLLBACK_ACTION
public static final EventType AFTER_ROLLBACK_ACTION
Fired after a rollback is performed
-
BEFORE_INSTALL_FILE
public static final EventType BEFORE_INSTALL_FILE
Fired before a file is installed. The event object will be of typeInstallerFileEvent
.
-
AFTER_INSTALL_FILE
public static final EventType AFTER_INSTALL_FILE
Fired after a file has been installed. The event object will be of typeInstallerFileEvent
.
-
DIRECTORY_CREATED
public static final EventType DIRECTORY_CREATED
Fired after a directory has been installed. The event object will be of typeInstallerDirectoryEvent
.
-
BEFORE_DOWNLOAD
public static final EventType BEFORE_DOWNLOAD
Fired before a file is downloaded. The event object will be of typeInstallerDownloadEvent
.
-
AFTER_DOWNLOAD
public static final EventType AFTER_DOWNLOAD
Fired before a file has been downloaded. The event object will be of typeInstallerDownloadEvent
.
-
SHOW_SCREEN
public static final EventType SHOW_SCREEN
Fired before a screen is shown.
-
FINISHING
public static final EventType FINISHING
Fired when the installer or uninstaller quits but before any cleanup has been performed.
-
FINISHED
public static final EventType FINISHED
Fired just before the installer or uninstaller quits.
-
CANCELLING
public static final EventType CANCELLING
Fired when the installer or uninstaller is cancelled but before any cleanup has been performed.
-
CANCELED
public static final EventType CANCELED
Fired just before the installer or uninstaller quits after having been cancelled.
-
VARIABLE_CHANGED
public static final EventType VARIABLE_CHANGED
Fired after a variable has been set.- See Also:
Context.setVariable(String, Object)
-
FILE_INSTALLATION_STARTED
public static final EventType FILE_INSTALLATION_STARTED
Fired before the file installation is started by the "Install files" action. You can get the total size and the total file count from the event object
-
-
Method Detail
-
values
public static EventType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (EventType c : EventType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static EventType valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
getOperationVerbose
public java.lang.String getOperationVerbose()
Get a verbose message that describes the operation that is connected with this event.- Returns:
- the message
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Enum<EventType>
-
-