Eclipse Custom Variable for Java Code Templates

Question

How do you add a new variable to be inserted into a Java code template. How do I add a variable to the list in Window->Preferences->Java->Code Style->Code Templates->Code->New Java Files->Edit->Insert Variable... ?

Currently my new files get created with:

${filecomment}
${package_declaration}
${typecomment}
${type_declaration}

I'd like them to get created with something like:

${begin_filecomment}
${package_declaration}
${typecomment}
${type_declaration}
${end_filecomment}

where begin_filecomment and end_filecomment appear in the Insert Variable list.

Answer 1

I'm pretty sure that the list of "variables" is generated by Eclipse and there is no way to add a new template variable.

What do you want ${begin_filecomment} and ${end_filecomment} to be? Just type the content into the Edit box - there is nothing that says you cannot put static content in there.

Answer 2

Yes, you can indeed add a variable to this list. See the extension point called

org.eclipse.ui.editors.templates

and you'll find out how.

Answer 3

I didn't try it, but maybe you could edit the template files in the JDT jar:

eclipse\plugins\org.eclipse.jdt.ui_*.jar\templates\

Answer 4

To contribute a new variable, you need to create a plugin and implement the org.eclipse.ui.editors.templates extension-point.

You have to contribute a sub-class of org.eclipse.jface.text.templates.TemplateVariableResolver that will implement the various resolve methods to resolve the placeholder to your desired value(s).

See here for help on the extension point and an example that contributes the ant variables.

As matt b says, you often just need to define your text as boilerplate, so implementing a variable for that is overkill.

Answer 5

See http://thomaswabner.wordpress.com/2009/08/21/use-your-own-variable-in-eclipse-code-templates/

Answer 6

and see http://ahoehma.wordpress.com/2009/08/24/use-maven-artifact-version-in-eclipse-templates/