Package com.install4j.api.beans
Class VariableErrorHandlingDescriptor
- java.lang.Object
-
- com.install4j.api.beans.VariableErrorHandlingDescriptor
-
public class VariableErrorHandlingDescriptor extends java.lang.Object
Specifies the error handling for variable replacements. Instances of this class are passed to some of thereplaceVariables(...)
methods inAbstractBean
.Each variable type (installer variable, I18N message, compiler and form variable) has its own error handling.
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.
-
-
Field Summary
Fields Modifier and Type Field Description static VariableErrorHandlingDescriptor
ALWAYS_ERROR_MESSAGE
Always replace undefined variables with an error message.static VariableErrorHandlingDescriptor
ALWAYS_EXCEPTION
Always throw exceptions for undefined variables.static VariableErrorHandlingDescriptor
ALWAYS_IGNORE
Ignore all undefined variables.static VariableErrorHandlingDescriptor
DEFAULT
The default error handling.
-
Constructor Summary
Constructors Constructor Description VariableErrorHandlingDescriptor(VariableErrorHandling installerVariables, VariableErrorHandling i18nKeys, VariableErrorHandling compilerVariables)
Construct a custom variable error handling LikeVariableErrorHandlingDescriptor(VariableErrorHandling, VariableErrorHandling, VariableErrorHandling, VariableErrorHandling)
with formVariables set toVariableErrorHandling.ERROR_MESSAGE
.VariableErrorHandlingDescriptor(VariableErrorHandling installerVariables, VariableErrorHandling i18nKeys, VariableErrorHandling compilerVariables, VariableErrorHandling formVariables)
Construct a custom variable error handling
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description VariableErrorHandling
getCompilerVariables()
Returns the error handling for compiler variables.VariableErrorHandling
getFormVariables()
Returns the error handling for form variables.VariableErrorHandling
getI18nKeys()
Returns the error handling for localization keys.VariableErrorHandling
getInstallerVariables()
Returns the error handling for installer variables.
-
-
-
Field Detail
-
DEFAULT
public static final VariableErrorHandlingDescriptor DEFAULT
The default error handling. Throw an exception fo undefined installer variables, replace undefined localization keys and compiler variables with an error message.
-
ALWAYS_IGNORE
public static final VariableErrorHandlingDescriptor ALWAYS_IGNORE
Ignore all undefined variables.
-
ALWAYS_ERROR_MESSAGE
public static final VariableErrorHandlingDescriptor ALWAYS_ERROR_MESSAGE
Always replace undefined variables with an error message.
-
ALWAYS_EXCEPTION
public static final VariableErrorHandlingDescriptor ALWAYS_EXCEPTION
Always throw exceptions for undefined variables.
-
-
Constructor Detail
-
VariableErrorHandlingDescriptor
public VariableErrorHandlingDescriptor(VariableErrorHandling installerVariables, VariableErrorHandling i18nKeys, VariableErrorHandling compilerVariables)
Construct a custom variable error handling LikeVariableErrorHandlingDescriptor(VariableErrorHandling, VariableErrorHandling, VariableErrorHandling, VariableErrorHandling)
with formVariables set toVariableErrorHandling.ERROR_MESSAGE
.
-
VariableErrorHandlingDescriptor
public VariableErrorHandlingDescriptor(VariableErrorHandling installerVariables, VariableErrorHandling i18nKeys, VariableErrorHandling compilerVariables, VariableErrorHandling formVariables)
Construct a custom variable error handling- Parameters:
installerVariables
- error handling for installer variablesi18nKeys
- error handling for localization keyscompilerVariables
- error handling for compiler variablesformVariables
- error handling for form variables
-
-
Method Detail
-
getInstallerVariables
public VariableErrorHandling getInstallerVariables()
Returns the error handling for installer variables.- Returns:
- the error handling
-
getI18nKeys
public VariableErrorHandling getI18nKeys()
Returns the error handling for localization keys.- Returns:
- the error handling
-
getCompilerVariables
public VariableErrorHandling getCompilerVariables()
Returns the error handling for compiler variables.- Returns:
- the error handling
-
getFormVariables
public VariableErrorHandling getFormVariables()
Returns the error handling for form variables.- Returns:
- the error handling
-
-