com.sap.ide.tools.core.patternfwk
Interface ISourcePatternTemplateHelper

All Known Subinterfaces:

ISourcePatternResult

public interface ISourcePatternTemplateHelper

This interface must be implemented by all template helper classes for Velocity source pattern code generation. It provides methods for the pattern to store all additionally needed information (e.g. the list of needed imports) and methods for the framework to retrieve this information lateron. This interface is extended by com.sap.ide.tools.core.patternfwk.ISourcePatternResult that additionally provides the generated coding when Velocity is not used for the code generation.

Method Summary

void	addImport(java.lang.String className) This method has to add an import to the list of import statements to insert into the source code.
java.lang.String[]	getImports() This method has to return the list of import statements to insert into the source code.
void	removeImport(java.lang.String className) This method has to remove an import from the list of import statements to insert into the source code.

Method Detail

addImport

public void addImport(java.lang.String className)

This method has to add an import to the list of import statements to insert into the source code.

Parameters:

className - The fully qualified class name of the class or package to import (e.g. "java.util.Vector" or "java.util.*").

removeImport

public void removeImport(java.lang.String className)

This method has to remove an import from the list of import statements to insert into the source code.

Parameters:

className - The fully qualified class name of the class or package not to import (e.g. "java.util.Vector" or "java.util.*").

getImports

public java.lang.String[] getImports()

This method has to return the list of import statements to insert into the source code.

Returns:

The fully qualified class names of the classes or packages to import as an array of java.lang.String (e.g. "java.util.Vector" or "java.util.*").