Environment

Lets you specify/view/adjust environment variables.

Environment variables can be used in header, footer and Javadoc templates to form expressions that will be resolved during printing. Embedded strings of the form $variable$ are replaced with their corresponding value. This process is called variable interpolation.

Environment variables are simple key/value pairs. Valid keys take the form [a-zA-Z_][a-zA-Z0-9_.\\-]* and are case-sensitive. Values can be freely chosen.

Example 2.1. Header template with environment variables expressions

//==============================================================
// file :       $file.name$
// project:     $project$
//
// create:      date:       $date$
//              by:         $author$
//
//--------------------------------------------------------------
// copyright:   BSJT Software License (see class documentation)
//==============================================================

Example 2.2. Sample environment variables

: author = John Doo
: project.description = Nukes: The OpenSource CMS

Jalopy lets you define custom variables, but also provides access to the Java environment variables as well as some Jalopy-specific variables that are generally useful for common source formatting needs.

Custom environment variables

Lets you view and/or modify the custom environment variables.

Figure 2.19. Custom Environment settings page

Use the Add... and Remove buttons to add or remove items to and from the list.

Figure 2.20. Add Custom Environment Variable

Select a variable and press the Change... button if you want to adjust an existing environment variable.

Figure 2.21. Change Custom Environment Variable

Local Overrides

Custom user variables are stored as part of your code convention and are therefore shared across a whole team. If you need to define user-specific information, e.g. to automatically add the name of the developer who creates a class, this is possible via the local overrides file ".user.properties".

When found in the Jalopy settings directory, the variables defined here will override any other custom or system variables. The overrides file uses the common java.util.Properties format.

On a typical Windows XP installation, the local overrides file for user John Doo would be

C:\Documents and Settings\John Doo\.jalopy\.user.properties

On Linux it might be

/home/John Doo/.jalopy/.user.properties

Further information about the Jalopy settings directory can be found in Chapter 2, Configuration.

To define/override the variables "author" and "division", the local overrides file might look like this:

Example 2.3. Local Overrides File

author=John Doo
division=IT_DEV_AR

Since 1.6

Please note that the environment may be overwritten manually using the Console and Ant Plug-ins as well. Please refer to the Plug-in documentation.