Additionally, Jalopy provides some local variables that are automatically set depending on the execution context. The current list of valid local variables reads as follows:
Table 2.4. Local environment variables
| Name | Description | Scope | Since |
|---|---|---|---|
| file | The absolute path of the currently processed source file
(e.g. /usr/projects/test/MyFile.java) | global | 1.0 |
| file.name | The name of the currently processed source file
(e.g. MyFile.java) | global | 1.0 |
| file.format | A string representation of the line ending character(s) used to write a file (UNIX, DOS or MAC) | global | 1.0 |
| convention | The name of the currently active code convention (as specified in the settings) | global | 1.0 |
| convention.desc | The description of the currently active code convention (as specified in the settings) | global | 1.0 |
| project | The name of the currently active project/profile. For IDE Plug-ins this resolves to the current IDE project, otherwise the active Jalopy profile name is used | global | 1.0.1 |
| project.desc | The description of the currently active Jalopy profile | global | 1.0.1 |
| tab.size | The current indentation setting (as specified in the settings) | global | 1.0 |
| date | The current date, formatted in the style specified in the Date/Time settings (see the section called “Date/Time” below) | global | 1.0 |
| date.year | The current year | global | 1.0 |
| date.long | The current date, formatted as
java.text.DateFormat
LONG style | global | 1.0 |
| date.full | The current date, formatted as
java.text.DateFormat
FULL style | global | 1.0 |
| time | The current time, formatted in the style specified in the Date/Time settings (see the section called “Date/Time” below) | global | 1.0 |
| time.long | The current time, formatted as
java.text.DateFormat
LONG style | global | 1.0 |
| time.full | The current time, formatted as
java.text.DateFormat
FULL style | global | 1.0 |
| package.name | The package name of the currently processed source file (e.g. com.foo.mypackage) | global | 1.0 |
| class.name | Holds the name of the currently processed class, interface or enum | Javadoc class, interface, field, constructor, method, getter, setter | 1.0 |
| field.name | Holds the name of the currently processed field | Javadoc field | 1.0 |
| field.type | Holds the type name of the currently processed field | Javadoc field | 1.0 |
| method.name | Holds the name of the currently processed method | Javadoc method | 1.0 |
| param.name | Holds the name of the currently processed Javadoc parameter tag | Javadoc constructor, method | 1.0 |
| param.type | Holds the type of the currently processed Javadoc parameter tag | Javadoc constructor, method | 1.0 |
| exception.type | Holds the type of the currently processed throws clause member | Javadoc constructor, method | 1.0 |
| return.type | Holds the return type of the currently processed method | Javadoc method | 1.0 |
| property.name | Holds the property name of the currently processed getter/setter method. You can control the behavior during variable interpolation with the “Format bean property” option | Javadoc getter/setter | 1.1 |
| Property.Name | Holds the capitalized property name of the currently processed getter/setter method | Javadoc getter/setter | 1.9.3 |