com.izforge.izpack.api.substitutor

Enum SubstitutionType

java.lang.Object

java.lang.Enum<SubstitutionType>

com.izforge.izpack.api.substitutor.SubstitutionType

All Implemented Interfaces:

Serializable, Comparable<SubstitutionType>

public enum SubstitutionType
extends Enum<SubstitutionType>

Enumeration for substitution type

Author:

Anthonin Bonnefoy

Enum Constant Summary

Enum Constants

Enum Constant and Description
TYPE_ANT Plain file with ANT-like variable markers, ie @param@
TYPE_AT Plain file with '@' start char.
TYPE_JAVA Java file, where \ have to be escaped.
TYPE_JAVA_PROPERTIES Java properties file.
TYPE_PLAIN Plain file.
TYPE_SHELL Shell file.
TYPE_XML XML file.

Method Summary

Modifier and Type	Method and Description
static SubstitutionType	getDefault()
String	getType()
static SubstitutionType	lookup(String typeString) Return the substitution type
static SubstitutionType	valueOf(String name) Returns the enum constant of this type with the specified name.
static SubstitutionType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TYPE_PLAIN

public static final SubstitutionType TYPE_PLAIN

Plain file.

TYPE_JAVA_PROPERTIES

public static final SubstitutionType TYPE_JAVA_PROPERTIES

Java properties file.

TYPE_XML

public static final SubstitutionType TYPE_XML

XML file.

TYPE_SHELL

public static final SubstitutionType TYPE_SHELL

Shell file.

TYPE_AT

public static final SubstitutionType TYPE_AT

Plain file with '@' start char.

TYPE_JAVA

public static final SubstitutionType TYPE_JAVA

Java file, where \ have to be escaped.

TYPE_ANT

public static final SubstitutionType TYPE_ANT

Plain file with ANT-like variable markers, ie @param@

Method Detail

values

public static SubstitutionType[] 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 (SubstitutionType c : SubstitutionType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SubstitutionType valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getType

public String getType()

getDefault

public static final SubstitutionType getDefault()

lookup

public static SubstitutionType lookup(String typeString)

Return the substitution type

Parameters:

typeString - Type of substitution in a string form

Returns:

Type of substitution from enum. Default is plain.