Class AbstractBean
- All Implemented Interfaces:
Bean
- Direct Known Subclasses:
AbstractFormComponent,AbstractInstallAction,AbstractInstallerOrUninstallerScreen,AbstractInstallerScreen,AbstractInstallOrUninstallAction,AbstractStyle,AbstractUninstallAction,AbstractUninstallerScreen
This class provides common utility methods for all bean types.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic voidexecuteActionListAsync(ActionList actionList, Object... extraScriptParameters) Asynchronously execute an action list.static booleanexecuteActionListSync(ActionList actionList, Object... extraScriptParameters) Synchronously execute an action list.static <T> TgetTextOverrideValue(Bean bean, String propertyName, Class<T> resultType) Get the value for a property for which a text replacement has been configured in the IDE.static FilereplaceVariables(File file) Replace all installer variables and localization keys in a file name.static File[]replaceVariables(File[] files) Replace all installer variables and localization keys in a file array.static StringreplaceVariables(String value) Same asreplaceVariables(String, ReplacementMode, VariableErrorHandlingDescriptor), withReplacementMode.PLAINas the replacement mode andVariableErrorHandlingDescriptor.DEFAULTas the error handling descriptor.static String[]replaceVariables(String[] values) Same asreplaceVariables(String[], VariableErrorHandlingDescriptor), withVariableErrorHandlingDescriptor.DEFAULTas the error handling descriptor.static String[]replaceVariables(String[] values, VariableErrorHandlingDescriptor errorHandlingDescriptor) Replace all installer variables and localization keys in a string array.static StringreplaceVariables(String value, ReplacementMode replacementMode) Same asreplaceVariables(String, ReplacementMode, VariableErrorHandlingDescriptor), withVariableErrorHandlingDescriptor.DEFAULTas the error handling descriptor.static StringreplaceVariables(String value, ReplacementMode replacementMode, VariableErrorHandlingDescriptor errorHandlingDescriptor) Replace all installer variables and localization keys in a string.static StringreplaceVariables(String value, VariableErrorHandlingDescriptor errorHandlingDescriptor) Same asreplaceVariables(String, ReplacementMode, VariableErrorHandlingDescriptor), withReplacementMode.PLAINas the replacement mode.static <T> TreplaceWithTextOverride(Bean bean, String propertyName, T defaultValue, Class resultType) A convenience method forgetTextOverrideValue(com.install4j.api.beans.Bean, java.lang.String, java.lang.Class<T>)that returns a default value if no replacement has been configured.protected booleanreplaceWithTextOverride(String propertyName, boolean defaultValue) protected bytereplaceWithTextOverride(String propertyName, byte defaultValue) protected charreplaceWithTextOverride(String propertyName, char defaultValue) protected doublereplaceWithTextOverride(String propertyName, double defaultValue) protected floatreplaceWithTextOverride(String propertyName, float defaultValue) protected intreplaceWithTextOverride(String propertyName, int defaultValue) protected longreplaceWithTextOverride(String propertyName, long defaultValue) protected shortreplaceWithTextOverride(String propertyName, short defaultValue) protected <T> TreplaceWithTextOverride(String propertyName, T defaultValue, Class resultType) static voidrollbackActionList(ActionList actionList) Roll back an action list.
-
Constructor Details
-
AbstractBean
public AbstractBean()
-
-
Method Details
-
replaceVariables
Same asreplaceVariables(String, ReplacementMode, VariableErrorHandlingDescriptor), withReplacementMode.PLAINas the replacement mode andVariableErrorHandlingDescriptor.DEFAULTas the error handling descriptor.- Parameters:
value- the original string- Returns:
- the string with all variables replaced.
- Throws:
UndefinedVariableException- if a variable name cannot be found and the error handling is set toVariableErrorHandling.EXCEPTIONfor the variable type.
-
replaceVariables
public static String replaceVariables(String value, ReplacementMode replacementMode) throws UndefinedVariableException Same asreplaceVariables(String, ReplacementMode, VariableErrorHandlingDescriptor), withVariableErrorHandlingDescriptor.DEFAULTas the error handling descriptor.- Parameters:
value- the original stringreplacementMode- the replacement mode- Returns:
- the string with all variables replaced.
- Throws:
UndefinedVariableException- if a variable name cannot be found and the error handling is set toVariableErrorHandling.EXCEPTIONfor the variable type.
-
replaceVariables
public static String replaceVariables(String value, VariableErrorHandlingDescriptor errorHandlingDescriptor) throws UndefinedVariableException Same asreplaceVariables(String, ReplacementMode, VariableErrorHandlingDescriptor), withReplacementMode.PLAINas the replacement mode.- Parameters:
value- the original stringerrorHandlingDescriptor- describes how missing variables should be treated for each variable type- Returns:
- the string with all variables replaced.
- Throws:
UndefinedVariableException- if a variable name cannot be found and the error handling is set toVariableErrorHandling.EXCEPTIONfor the variable type.
-
replaceVariables
public static String replaceVariables(String value, ReplacementMode replacementMode, VariableErrorHandlingDescriptor errorHandlingDescriptor) throws UndefinedVariableException Replace all installer variables and localization keys in a string.Note: compiler variables in the project are replaced at compile time. Compiler variables in external files, such as a custom localization file, are not replaced at a compile time.
- Parameters:
value- the original stringreplacementMode- the replacement modeerrorHandlingDescriptor- describes how missing variables should be treated for each variable type- Returns:
- the string with all variables replaced.
- Throws:
UndefinedVariableException- if a variable name cannot be found and the error handling is set toVariableErrorHandling.EXCEPTIONfor the variable type.
-
replaceVariables
Replace all installer variables and localization keys in a file name. The used error handling descriptor isVariableErrorHandlingDescriptor.DEFAULT.Note: compiler variables in the project are replaced at compile time. Compiler variables in external files, such as a custom localization file, are not replaced at a compile time.
- Parameters:
file- the original file- Returns:
- the file with all variables replaced in its name.
- Throws:
UndefinedVariableException- if a variable name cannot be found and the error handling is set toVariableErrorHandling.EXCEPTIONfor the variable type.
-
replaceVariables
Same asreplaceVariables(String[], VariableErrorHandlingDescriptor), withVariableErrorHandlingDescriptor.DEFAULTas the error handling descriptor.- Parameters:
values- the original array- Returns:
- the array with all variables replaced
- Throws:
UndefinedVariableException- if a variable name cannot be found and the error handling is set toVariableErrorHandling.EXCEPTIONfor the variable type.
-
replaceVariables
public static String[] replaceVariables(String[] values, VariableErrorHandlingDescriptor errorHandlingDescriptor) throws UndefinedVariableException Replace all installer variables and localization keys in a string array. For array elements that consist of an installer variable that in turn contains an array or a collection value, the elements of that array or collection value will be inserted into the returned array. For this reason, the returned array may have more elements than the original array. For example, if the array passed in as an argument has the elements:
and the variable[0] = "One" [1] = "${installer:myVariable}" [2] = "Three"myVariablehas a String array value with the elements
then the returned array will be[0] = "Blue" [1] = "Green"[0] = "One" [1] = "Blue" [2] = "Green" [3] = "Three"If the array in an installer variable is not of type
String[]or the collection is not of typeList<String>, each element will be converted to a string by callingtoString()on it.Note: compiler variables are replaced at compile time.
- Parameters:
values- the original arrayerrorHandlingDescriptor- describes how missing variables should be treated for each variable type- Returns:
- the array with all variables replaced
- Throws:
UndefinedVariableException- if a variable name cannot be found and the error handling is set toVariableErrorHandling.EXCEPTIONfor the variable type.
-
replaceVariables
Replace all installer variables and localization keys in a file array. This method is analogous toreplaceVariables(String[]).- Parameters:
files- the original array- Returns:
- the array with all variables replaced
- Throws:
UndefinedVariableException- if a variable name cannot be found and the error handling is set toVariableErrorHandling.EXCEPTIONfor the variable type.
-
executeActionListSync
public static boolean executeActionListSync(ActionList actionList, Object... extraScriptParameters) throws UserCanceledException Synchronously execute an action list. You should not use this method from a form component because it will block the EDT. UseexecuteActionListAsync(ActionList, Object...)instead.- Parameters:
actionList- the action list object from your bean property.extraScriptParameters- if the action list provides extra script parameters in the BeanInfo by callingActionListPropertyDescriptor.setExtraScriptParameters(ScriptParameter[]), you have to pass them here.- Returns:
- whether the list of actions was terminated due to an error. This can only happen if the user selected
the "Break if an error occurs" check box in the configuration dialog of the action list, meaning that
the
ActionList.isBreakOnError()of the argument returnstrue. To detect errors in absence of this flag, callContext.setErrorOccurred(boolean)with an argument offalsebefore calling this method and check the result ofContext.isErrorOccurred()afterwards. - Throws:
UserCanceledException
-
executeActionListAsync
Asynchronously execute an action list. Do not invoke this method from an action, it will throw anIllegalStateExceptionin that case. For actions, useexecuteActionListSync(ActionList, Object...)instead. This method is intended to be used form a form component and will disable all components on the current screen while the action list is being executed.- Parameters:
actionList- the action list object from your bean property.extraScriptParameters- if the action list provides extra script parameters in the BeanInfo by callingActionListPropertyDescriptor.setExtraScriptParameters(ScriptParameter[]), you have to pass them here.
-
rollbackActionList
Roll back an action list. This will only have an effect if called from theInstallAction.rollback(InstallerContext)method and if you calledexecuteActionListSync(ActionList, Object...)before- Parameters:
actionList- the action list object from your bean property
-
getTextOverrideValue
Get the value for a property for which a text replacement has been configured in the IDE.For properties with non-String values of certain types, you can choose to switch to text entry mode in the context menu. This mechanism has to be enabled by calling
Install4JPropertyDescriptor.setAllowTextOverride(boolean)withtruein the property descriptor.The user can set the text value to an installer variable expression or to a compiler variable expression. In the getter of the property, the
replaceWithTextOverride()method with the appropriate return type has to be called to perform the actual replacement. All these instance methods call this static method, so the feature also works for classes that do not extendAbstractBean.- Parameters:
bean- the bean for which the replacement should be performedpropertyName- the property whose value should be replacedresultType- the type of the property- Returns:
- the replaced value or null if no replacement has been configured
-
replaceWithTextOverride
public static <T> T replaceWithTextOverride(Bean bean, String propertyName, T defaultValue, Class resultType) A convenience method forgetTextOverrideValue(com.install4j.api.beans.Bean, java.lang.String, java.lang.Class<T>)that returns a default value if no replacement has been configured. -
replaceWithTextOverride
- See Also:
-
replaceWithTextOverride
- See Also:
-
replaceWithTextOverride
- See Also:
-
replaceWithTextOverride
- See Also:
-
replaceWithTextOverride
- See Also:
-
replaceWithTextOverride
- See Also:
-
replaceWithTextOverride
- See Also:
-
replaceWithTextOverride
- See Also:
-
replaceWithTextOverride
- See Also:
-