com.mcdermottroe.exemplar
Interface Constants

public interface Constants

Holds non-user-visible constant values for the entire program. The constants are organized into several inner interfaces to keep them categorized and to allow some classes to "implement" them in order to import the constants into their namespace. This import-by-implement pattern should be used sparingly and only where there exists a sub-interface which is clearly related to the implementing class.

Since:

0.1

Nested Class Summary

static interface	Constants.Character Character literal constants.
static interface	Constants.Format Format strings.
static interface	Constants.Input Input module constants.
static interface	Constants.Options Options constants.
static interface	Constants.Output Output module constants.
static interface	Constants.Regex Regular expression constants.
static interface	Constants.UI Constants for UI.
static interface	Constants.XMLExternalIdentifier Constants for XML external identifiers.

Field Summary

static int	BASE_DECIMAL The base for the decimal number system.
static int	BASE_HEXADECIMAL The base for the hexadecimal number system.
static String[]	COPYRIGHT_MESSAGE A short message about the copyright and license.
static String	CWD The current working directory at runtime.
static String	CWD_PROPERTY The system property name for the current working directory.
static String	DEFAULT_MESSAGE The default message that is displayed if something really screws up in the localisation process.
static String	EOL The system end of line marker.
static String	EOL_PROPERTY The system property name for the end of line marker.
static String	FILE_JAR_PREFIX The prefix to a URL that is pointing to a file.
static int	HASHCODE_MAGIC_NUMBER The magic number for calculating hash codes in implementations of Object.hashCode().
static int	INFINITY A close approximation to infinity.
static String	JAR_METAINF_DIR The META-INF directory inside a JAR file.
static double	MILLISECONDS_IN_A_SECOND The number of milliseconds in a second.
static String	NULL_STRING The String representation of null.
static String	PACKAGE The package that the program is rooted in.
static String	PROGRAM_NAME The name of the program.
static String	PROGRAM_VERSION The version of the program.
static String	TIMESTAMP_FORMAT The timestamp format used in the templates.
static String	URL_JAR_PREFIX The prefix to a URL that is pointing to a JAR file.

Field Detail

PROGRAM_NAME

static final String PROGRAM_NAME

The name of the program. Where possible all references to the name of the program should be made via this. It would be preferable to not have to go through the same kind of pains as Phoenix^WFirebird^WFirefox.

See Also:

Constant Field Values

PROGRAM_VERSION

static final String PROGRAM_VERSION

The version of the program. This should only be changed when dictated by the roadmap. A copy of the roadmap can be found in the root directory of the source distribution.

See Also:

Constant Field Values

COPYRIGHT_MESSAGE

static final String[] COPYRIGHT_MESSAGE

A short message about the copyright and license. The years mentioned in this message correspond to the range of years for all of the files making up the program. Some of the files do not date back to 2003. It is an error to modify the contents of this array from code.

PACKAGE

static final String PACKAGE

The package that the program is rooted in. All references to packages within the program must be computed from this.

CWD_PROPERTY

static final String CWD_PROPERTY

The system property name for the current working directory.

See Also:

Constant Field Values

CWD

static final String CWD

The current working directory at runtime.

EOL_PROPERTY

static final String EOL_PROPERTY

The system property name for the end of line marker.

See Also:

Constant Field Values

EOL

static final String EOL

The system end of line marker.

TIMESTAMP_FORMAT

static final String TIMESTAMP_FORMAT

The timestamp format used in the templates. A timestamp which includes the time might seem more appropriate, but it breaks test code which relies on files generated seconds apart to be identical.

See Also:

Constant Field Values

DEFAULT_MESSAGE

static final String DEFAULT_MESSAGE

The default message that is displayed if something really screws up in the localisation process. This should never be seen by users.

See Also:

Constant Field Values

INFINITY

static final int INFINITY

A close approximation to infinity. :-)

See Also:

Constant Field Values

HASHCODE_MAGIC_NUMBER

static final int HASHCODE_MAGIC_NUMBER

The magic number for calculating hash codes in implementations of Object.hashCode().

See Also:

Constant Field Values

BASE_DECIMAL

static final int BASE_DECIMAL

The base for the decimal number system.

See Also:

Constant Field Values

BASE_HEXADECIMAL

static final int BASE_HEXADECIMAL

The base for the hexadecimal number system.

See Also:

Constant Field Values

FILE_JAR_PREFIX

static final String FILE_JAR_PREFIX

The prefix to a URL that is pointing to a file.

See Also:

Constant Field Values

URL_JAR_PREFIX

static final String URL_JAR_PREFIX

The prefix to a URL that is pointing to a JAR file.

See Also:

Constant Field Values

JAR_METAINF_DIR

static final String JAR_METAINF_DIR

The META-INF directory inside a JAR file.

See Also:

Constant Field Values

NULL_STRING

static final String NULL_STRING

The String representation of null.

MILLISECONDS_IN_A_SECOND

static final double MILLISECONDS_IN_A_SECOND

The number of milliseconds in a second.

See Also:

Constant Field Values