com.izforge.izpack.api.substitutor

Interface VariableSubstitutor

All Superinterfaces:

Serializable

public interface VariableSubstitutor
extends Serializable

Substitutes variables occurring in an input stream or a string. This implementation supports a generic variable value mapping and escapes the possible special characters occurring in the substituted values. The file types specifically supported are plain text files (no escaping), Java properties files, and XML files. A valid variable name matches the regular expression [a-zA-Z][a-zA-Z0-9_]* and names are case sensitive. Variables are referenced either by $NAME or ${NAME} (the latter syntax being useful in situations like ${NAME}NOTPARTOFNAME). If a referenced variable is undefined then it is not substituted but the corresponding part of the stream is copied as is.

Author:

Johannes Lehtinen

Method Summary

Modifier and Type	Method and Description
void	setBracesRequired(boolean braces) Specify whether this substitutor requires braces.
int	substitute(InputStream in, OutputStream out, SubstitutionType type, String encoding) Substitutes the variables found in the specified input stream.
String	substitute(InputStream in, SubstitutionType type) Substitute method Variant that gets An Input Stream and returns A String
int	substitute(Reader reader, Writer writer, SubstitutionType type) Substitutes the variables found in the data read from the specified reader.
String	substitute(String str) Substitutes the variables found in the specified string.
String	substitute(String str, SubstitutionType type) Substitutes the variables found in the specified string.

Method Detail

setBracesRequired

void setBracesRequired(boolean braces)

Specify whether this substitutor requires braces.

substitute

String substitute(String str)

Substitutes the variables found in the specified string. Escapes special characters using file type specific escaping if necessary.
The escaped type will be plain.

Parameters:

str - the string to check for variables

Returns:

the string with substituted variables

Throws:

IllegalArgumentException - if unknown escaping type specified

substitute

String substitute(String str,
                  SubstitutionType type)

Substitutes the variables found in the specified string. Escapes special characters using file type specific escaping if necessary.

Parameters:

str - the string to check for variables

type - the escaping type

Returns:

the string with substituted variables

Throws:

IllegalArgumentException - if unknown escaping type specified

substitute

int substitute(InputStream in,
               OutputStream out,
               SubstitutionType type,
               String encoding)
        throws Exception

Substitutes the variables found in the specified input stream. Escapes special characters using file type specific escaping if necessary.

Parameters:

in - the input stream to read

out - the output stream to write

type - the file type or null for plain

encoding - the character encoding or null for default

Returns:

the number of substitutions made

Throws:

IllegalArgumentException - if unknown file type specified

UnsupportedEncodingException - if encoding not supported

IOException - if an I/O error occurs

Exception

substitute

String substitute(InputStream in,
                  SubstitutionType type)
           throws Exception

Substitute method Variant that gets An Input Stream and returns A String

Parameters:

in - The Input Stream, with Placeholders

type - The used FormatType

Returns:

the substituted result as string

Throws:

IllegalArgumentException - If a wrong input was given.

UnsupportedEncodingException - If the file comes with a wrong Encoding

IOException - If an I/O Error occurs.

Exception

substitute

int substitute(Reader reader,
               Writer writer,
               SubstitutionType type)
        throws Exception

Substitutes the variables found in the data read from the specified reader. Escapes special characters using file type specific escaping if necessary.

Parameters:

reader - the reader to read

writer - the writer used to write data out

type - the file type or null for plain

Returns:

the number of substitutions made

Throws:

IllegalArgumentException - if unknown file type specified

IOException - if an I/O error occurs

Exception