Title

Previous: Info

Next: User Defined Variables

title

5.4 Environment

title

5.4.1 Environment Variables

Jindent provides different kind of user defined templates which can be used to insert:

headers
footers
JavaDoc comments
note comments

All these templates can contain 'environment variables'. Environment variables can be used to transfer informations from Jindent's environment to templates.
For example environment variable $declarationName$ which can be used in JavaDoc templates will be substituted by the name of the corresponding declaration (this can be a method name, class name, field name, and so on...).

Environment variables are either from type $variable$ or %variable%.

For instance a class declaration JavaDoc template which looks like:

				/**                                     

				 * $declarationName$, $declarationType$ 

				 *                                      

				 */

would be inserted before a class declaration like:

				/**                                     

				 * MyClass, class                       

				 *                                      

				 */                                     

				public class MyClass {                  

				    ...                                 

				}

Whereas the %variable% syntax can be used to create JavaDocs in boxes:
For instance a class declaration template which looks like:

				/*************************************  

				 * %declarationName%                 *  

				 *                                   *  

				 *************************************/

would be inserted before a class declaration like:

				/*************************************  

				 * MyClass                           *  

				 *                                   *  

				 *************************************/ 

				public class MyClass {                  

				    ...                                 

				}

Substitution of %variable% does not change the alignment of all other template elements.
Whereas insertion of $variable$ inserts its substituted content fluently.

List of auto-generated environment variables which can be used in templates:

Variable name:	Description:	Accessible from template:
conventioName	Name of used code convention	all
date	Current date	all
declarationName	Name of declaration	all JavaDocs
declarationType	Type of declaration	all JavaDocs
exceptionName	Name of exception	method/constructor JavaDocs
fileFormat	File format (Dos, Unix, Mac)	all
fileName	Short filename of current source file	all
fullFileName	Full filename of current source file	all
packageName	Package name of current source file	all
paramName	Name of parameter	method/constructor JavaDocs
paramType	Type of parameter	method/constructor JavaDocs
returnType	Method return type	method JavaDocs
tabSize	Set output tab size	all
textFormat	Same as file format (Dos, Unix, Mac)	all

Additionally environment variables can be user defined or contain informations from the system.

5.4.1.1 Special Variables

Convention name

Defines the name of used code convention. This environment variable can be accessed from all templates. Use $conventionName$ or %conventionName% to resolve it.

Date format

Defines a date format. This environment variable can be accessed from all templates. Use $date$ or %date% to resolve it.

Even if Jindent provides a list with date format presets it is possible to customize other date formats by hand.
The date format setting uses Java's JDK class java.text.SimpleDateFormat to format the current date. For details how to use its formatting patterns please refer to: java.text.SimpleDateFormat