|
install4j API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.install4j.api.beans.AbstractBean
public abstract class AbstractBean
Common base class for all abstract super-classes for beans that are handled by install4j. It is not recommended to extend this class directly. Concrete super-classes exist for
This class provides common utility methods fir all bean types.
Constructor Summary | |
---|---|
AbstractBean()
|
Method Summary | |
---|---|
static java.io.File |
replaceVariables(java.io.File file)
Replace all installer variables and localization keys in a file name. |
static java.io.File[] |
replaceVariables(java.io.File[] files)
Replace all installer variables and localization keys in a file array. |
static java.lang.String |
replaceVariables(java.lang.String value)
Same as replaceVariables(String, ReplacementMode, VariableErrorHandlingDescriptor) , with
ReplacementMode.PLAIN as the replacement mode and
VariableErrorHandlingDescriptor.DEFAULT as the error handling descriptor. |
static java.lang.String[] |
replaceVariables(java.lang.String[] values)
Same as replaceVariables(String[], VariableErrorHandlingDescriptor) , with
VariableErrorHandlingDescriptor.DEFAULT as the error handling descriptor. |
static java.lang.String[] |
replaceVariables(java.lang.String[] values,
VariableErrorHandlingDescriptor errorHandlingDescriptor)
Replace all installer variables and localization keys in a string array. |
static java.lang.String |
replaceVariables(java.lang.String value,
ReplacementMode replacementMode)
Same as replaceVariables(String, ReplacementMode, VariableErrorHandlingDescriptor) , with
VariableErrorHandlingDescriptor.DEFAULT as the error handling descriptor. |
static java.lang.String |
replaceVariables(java.lang.String value,
ReplacementMode replacementMode,
VariableErrorHandlingDescriptor errorHandlingDescriptor)
Replace all installer variables and localization keys in a string. |
static java.lang.String |
replaceVariables(java.lang.String value,
VariableErrorHandlingDescriptor errorHandlingDescriptor)
Same as replaceVariables(String, ReplacementMode, VariableErrorHandlingDescriptor) , with
ReplacementMode.PLAIN as the replacement mode. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AbstractBean()
Method Detail |
---|
public static java.lang.String replaceVariables(java.lang.String value) throws UndefinedVariableException
replaceVariables(String, ReplacementMode, VariableErrorHandlingDescriptor)
, with
ReplacementMode.PLAIN
as the replacement mode and
VariableErrorHandlingDescriptor.DEFAULT
as the error handling descriptor.
value
- the original string
UndefinedVariableException
- if a variable name cannot be found and the error handling is set to
VariableErrorHandling.EXCEPTION
for the variable type.public static java.lang.String replaceVariables(java.lang.String value, ReplacementMode replacementMode) throws UndefinedVariableException
replaceVariables(String, ReplacementMode, VariableErrorHandlingDescriptor)
, with
VariableErrorHandlingDescriptor.DEFAULT
as the error handling descriptor.
value
- the original stringreplacementMode
- the replacement mode
UndefinedVariableException
- if a variable name cannot be found and the error handling is set to
VariableErrorHandling.EXCEPTION
for the variable type.public static java.lang.String replaceVariables(java.lang.String value, VariableErrorHandlingDescriptor errorHandlingDescriptor) throws UndefinedVariableException
replaceVariables(String, ReplacementMode, VariableErrorHandlingDescriptor)
, with
ReplacementMode.PLAIN
as the replacement mode.
value
- the original stringerrorHandlingDescriptor
- describes how missing variables should be treated for each variable type
UndefinedVariableException
- if a variable name cannot be found and the error handling is set to
VariableErrorHandling.EXCEPTION
for the variable type.public static java.lang.String replaceVariables(java.lang.String value, ReplacementMode replacementMode, VariableErrorHandlingDescriptor errorHandlingDescriptor) throws UndefinedVariableException
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.
value
- the original stringreplacementMode
- the replacement modeerrorHandlingDescriptor
- describes how missing variables should be treated for each variable type
UndefinedVariableException
- if a variable name cannot be found and the error handling is set to
VariableErrorHandling.EXCEPTION
for the variable type.public static java.io.File replaceVariables(java.io.File file) throws UndefinedVariableException
VariableErrorHandlingDescriptor.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.
file
- the original file
UndefinedVariableException
- if a variable name cannot be found and the error handling is set to
VariableErrorHandling.EXCEPTION
for the variable type.public static java.lang.String[] replaceVariables(java.lang.String[] values) throws UndefinedVariableException
replaceVariables(String[], VariableErrorHandlingDescriptor)
, with
VariableErrorHandlingDescriptor.DEFAULT
as the error handling descriptor.
values
- the original array
UndefinedVariableException
- if a variable name cannot be found and the error handling is set to
VariableErrorHandling.EXCEPTION
for the variable type.public static java.lang.String[] replaceVariables(java.lang.String[] values, VariableErrorHandlingDescriptor errorHandlingDescriptor) throws UndefinedVariableException
[0] = "One" [1] = "${installer:myVariable}" [2] = "Three"and the variable myVariable has a String array value with the elements
[0] = "Blue" [1] = "Green"then the returned array will be
[0] = "One" [1] = "Blue" [2] = "Green" [3] = "Three"
If the array in an installer variable is not of type String[], each element will be converted to a string by calling toString() on it.
Note: compiler variables are replaced at compile time.
values
- the original arrayerrorHandlingDescriptor
- describes how missing variables should be treated for each variable type
UndefinedVariableException
- if a variable name cannot be found and the error handling is set to
VariableErrorHandling.EXCEPTION
for the variable type.public static java.io.File[] replaceVariables(java.io.File[] files) throws UndefinedVariableException
replaceVariables(String[])
.
files
- the original array
UndefinedVariableException
- if a variable name cannot be found and the error handling is set to
VariableErrorHandling.EXCEPTION
for the variable type.
|
install4j API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |