org.eclipse.jdt.core.manipulation

Class CodeGeneration

java.lang.Object

org.eclipse.jdt.core.manipulation.CodeGeneration

public class CodeGeneration
extends Object

Class that offers access to the templates contained in the 'code templates' preference page.

This class is not intended to be subclassed or instantiated by clients.

Since:

1.11

Restriction:

This class is not intended to be subclassed by clients.

Restriction:

This class is not intended to be instantiated by clients.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANNOTATION_BODY_TEMPLATE_ID Constant ID for the type kind to be used in getTypeBody(String, ICompilationUnit, String, String) to get the code template used for a new annotation type body.
static String	CLASS_BODY_TEMPLATE_ID Constant ID for the type kind to be used in getTypeBody(String, ICompilationUnit, String, String) to get the code template used for a new class type body.
static String	ENUM_BODY_TEMPLATE_ID Constant ID for the type kind to be used in getTypeBody(String, ICompilationUnit, String, String) to get the code template used for a new enum type body.
static String	INTERFACE_BODY_TEMPLATE_ID Constant ID for the type kind to be used in getTypeBody(String, ICompilationUnit, String, String) to get the code template used for a new interface type body.

Method Summary

Modifier and Type	Method and Description
static String	getCompilationUnitContent(ICompilationUnit cu, String typeComment, String typeContent, String lineDelimiter) Returns the content for a new compilation unit using the 'new Java file' code template.
static String	getCompilationUnitContent(ICompilationUnit cu, String fileComment, String typeComment, String typeContent, String lineDelimiter) Returns the content for a new compilation unit using the 'new Java file' code template.
static String	getFieldComment(ICompilationUnit cu, String typeName, String fieldName, String lineDelimiter) Returns the content for a new field comment using the 'field comment' code template.
static String	getFileComment(ICompilationUnit cu, String lineDelimiter) Returns the content for a new file comment using the 'file comment' code template.
static String	getGetterComment(ICompilationUnit cu, String declaringTypeName, String methodName, String fieldName, String fieldType, String bareFieldName, String lineDelimiter) Returns the comment for a getter method using the getter comment template.
static String	getGetterMethodBodyContent(ICompilationUnit cu, String declaringTypeName, String methodName, String fieldName, String lineDelimiter) Returns the content of body for a getter method using the getter method body template.
static String	getMethodBodyContent(ICompilationUnit cu, String declaringTypeName, String methodName, boolean isConstructor, String bodyStatement, String lineDelimiter) Returns the content of the body for a method or constructor using the method body templates.
static String	getMethodComment(ICompilationUnit cu, String declaringTypeName, MethodDeclaration decl, boolean isDeprecated, String overriddenMethodName, String overriddenMethodDeclaringTypeName, String[] overriddenMethodParameterTypeNames, String lineDelimiter) Returns the comment for a method or constructor using the comment code templates (constructor / method / overriding method).
static String	getMethodComment(ICompilationUnit cu, String declaringTypeName, MethodDeclaration decl, IMethodBinding overridden, String lineDelimiter) Returns the comment for a method or constructor using the comment code templates (constructor / method / overriding method).
static String	getMethodComment(ICompilationUnit cu, String declaringTypeName, String methodName, String[] paramNames, String[] excTypeSig, String retTypeSig, IMethod overridden, String lineDelimiter) Returns the comment for a method or constructor using the comment code templates (constructor / method / overriding method).
static String	getMethodComment(ICompilationUnit cu, String declaringTypeName, String methodName, String[] paramNames, String[] excTypeSig, String retTypeSig, String[] typeParameterNames, IMethod overridden, String lineDelimiter) Returns the comment for a method or constructor using the comment code templates (constructor / method / overriding method).
static String	getMethodComment(IMethod method, IMethod overridden, String lineDelimiter) Returns the comment for a method or constructor using the comment code templates (constructor / method / overriding method).
static String	getSetterComment(ICompilationUnit cu, String declaringTypeName, String methodName, String fieldName, String fieldType, String paramName, String bareFieldName, String lineDelimiter) Returns the comment for a setter method using the setter method body template.
static String	getSetterMethodBodyContent(ICompilationUnit cu, String declaringTypeName, String methodName, String fieldName, String paramName, String lineDelimiter) Returns the content of body for a setter method using the setter method body template.
static String	getTypeBody(String typeKind, ICompilationUnit cu, String typeName, String lineDelim) Returns the content of a new new type body using the 'type body' code templates.
static String	getTypeComment(ICompilationUnit cu, String typeQualifiedName, String lineDelimiter) Returns the content for a new type comment using the 'type comment' code template.
static String	getTypeComment(ICompilationUnit cu, String typeQualifiedName, String[] typeParameterNames, String lineDelimiter) Returns the content for a new type comment using the 'type comment' code template.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_BODY_TEMPLATE_ID

public static final String CLASS_BODY_TEMPLATE_ID

Constant ID for the type kind to be used in getTypeBody(String, ICompilationUnit, String, String) to get the code template used for a new class type body.

Since:

3.2

See Also:

Constant Field Values

INTERFACE_BODY_TEMPLATE_ID

public static final String INTERFACE_BODY_TEMPLATE_ID

Constant ID for the type kind to be used in getTypeBody(String, ICompilationUnit, String, String) to get the code template used for a new interface type body.

Since:

3.2

See Also:

Constant Field Values

ENUM_BODY_TEMPLATE_ID

public static final String ENUM_BODY_TEMPLATE_ID

Constant ID for the type kind to be used in getTypeBody(String, ICompilationUnit, String, String) to get the code template used for a new enum type body.

Since:

3.2

See Also:

Constant Field Values

ANNOTATION_BODY_TEMPLATE_ID

public static final String ANNOTATION_BODY_TEMPLATE_ID

Constant ID for the type kind to be used in getTypeBody(String, ICompilationUnit, String, String) to get the code template used for a new annotation type body.

Since:

3.2

See Also:

Constant Field Values

Method Detail

getCompilationUnitContent

public static String getCompilationUnitContent(ICompilationUnit cu,
                                               String typeComment,
                                               String typeContent,
                                               String lineDelimiter)
                                        throws CoreException

Returns the content for a new compilation unit using the 'new Java file' code template.

Parameters:

cu - The compilation unit to create the source for. The compilation unit does not need to exist.

typeComment - The comment for the type to be created. Used when the code template contains a ${typecomment} variable. Can be null if no comment should be added.

typeContent - The code of the type, including type declaration and body.

lineDelimiter - The line delimiter to be used.

Returns:

Returns the new content or null if the template is undefined or empty.

Throws:

CoreException - Thrown when the evaluation of the code template fails.

getCompilationUnitContent

public static String getCompilationUnitContent(ICompilationUnit cu,
                                               String fileComment,
                                               String typeComment,
                                               String typeContent,
                                               String lineDelimiter)
                                        throws CoreException

Returns the content for a new compilation unit using the 'new Java file' code template.

Parameters:

cu - The compilation unit to create the source for. The compilation unit does not need to exist.

fileComment - The file comment to be used when the code template contains a ${filecomment} variable. Can be null if no comment should be added.

typeComment - The comment for the type to be created. Used when the code template contains a ${typecomment} variable. Can be null if no comment should be added.

typeContent - The code of the type, including type declaration and body.

lineDelimiter - The line delimiter to be used.

Returns:

Returns the new content or null if the template is undefined or empty.

Throws:

CoreException - Thrown when the evaluation of the code template fails.

Since:

3.1

getFileComment

public static String getFileComment(ICompilationUnit cu,
                                    String lineDelimiter)
                             throws CoreException

Returns the content for a new file comment using the 'file comment' code template. The returned content is unformatted and is not indented.

Parameters:

cu - The compilation unit to add the comment to. The compilation unit does not need to exist.

lineDelimiter - The line delimiter to be used.

Returns:

Returns the new content or null if the code template is undefined or empty. The returned content is unformatted and is not indented.

Throws:

CoreException - Thrown when the evaluation of the code template fails.

Since:

3.1

getTypeComment

public static String getTypeComment(ICompilationUnit cu,
                                    String typeQualifiedName,
                                    String lineDelimiter)
                             throws CoreException

Returns the content for a new type comment using the 'type comment' code template. The returned content is unformatted and is not indented.

Parameters:

cu - The compilation unit where the type is contained. The compilation unit does not need to exist.

typeQualifiedName - The name of the type to which the comment is added. For inner types the name must be qualified and include the outer types names (dot separated). See IType.getTypeQualifiedName(char).

lineDelimiter - The line delimiter to be used.

Returns:

Returns the new content or null if the code template is undefined or empty. The returned content is unformatted and is not indented.

Throws:

CoreException - Thrown when the evaluation of the code template fails.

getTypeComment

public static String getTypeComment(ICompilationUnit cu,
                                    String typeQualifiedName,
                                    String[] typeParameterNames,
                                    String lineDelimiter)
                             throws CoreException

Returns the content for a new type comment using the 'type comment' code template. The returned content is unformatted and is not indented.

Parameters:

cu - The compilation unit where the type is contained. The compilation unit does not need to exist.

typeQualifiedName - The name of the type to which the comment is added. For inner types the name must be qualified and include the outer types names (dot separated). See IType.getTypeQualifiedName(char).

typeParameterNames - The type parameter names

lineDelimiter - The line delimiter to be used.

Returns:

Returns the new content or null if the code template is undefined or empty. The returned content is unformatted and is not indented.

Throws:

CoreException - Thrown when the evaluation of the code template fails.

Since:

3.1

getTypeBody

public static String getTypeBody(String typeKind,
                                 ICompilationUnit cu,
                                 String typeName,
                                 String lineDelim)
                          throws CoreException

Returns the content of a new new type body using the 'type body' code templates. The returned content is unformatted and is not indented.

Parameters:

typeKind - The type kind ID of the body template. Valid values are CLASS_BODY_TEMPLATE_ID, INTERFACE_BODY_TEMPLATE_ID, ENUM_BODY_TEMPLATE_ID and ANNOTATION_BODY_TEMPLATE_ID.

cu - The compilation unit where the type is contained. The compilation unit does not need to exist.

typeName - The name of the type(for embedding in the template as a user variable).

lineDelim - The line delimiter to be used.

Returns:

Returns the new content or null if the code template is undefined or empty. The returned content is unformatted and is not indented.

Throws:

CoreException - Thrown when the evaluation of the code template fails.

Since:

3.2

getFieldComment

public static String getFieldComment(ICompilationUnit cu,
                                     String typeName,
                                     String fieldName,
                                     String lineDelimiter)
                              throws CoreException

Returns the content for a new field comment using the 'field comment' code template. The returned content is unformatted and is not indented.

Parameters:

cu - The compilation unit where the field is contained. The compilation unit does not need to exist.

typeName - The name of the field declared type.

fieldName - The name of the field to which the comment is added.

lineDelimiter - The line delimiter to be used.

Returns:

Returns the new content or null if the code template is undefined or empty. The returned content is unformatted and is not indented.

Throws:

CoreException - Thrown when the evaluation of the code template fails.

Since:

3.0

getMethodComment

public static String getMethodComment(ICompilationUnit cu,
                                      String declaringTypeName,
                                      MethodDeclaration decl,
                                      IMethodBinding overridden,
                                      String lineDelimiter)
                               throws CoreException

Returns the comment for a method or constructor using the comment code templates (constructor / method / overriding method). null is returned if the template is empty.

Parameters:

cu - The compilation unit to which the method belongs. The compilation unit does not need to exist.

declaringTypeName - Name of the type to which the method belongs. For inner types the name must be qualified and include the outer types names (dot separated). See IType.getTypeQualifiedName(char).

decl - The MethodDeclaration AST node that will be added as new method. The node does not need to exist in an AST (no parent needed) and does not need to resolve. See AST.newMethodDeclaration() for how to create such a node.

overridden - The binding of the method to which to add an "@see" link or null if no link should be created.

lineDelimiter - The line delimiter to be used.

Returns:

Returns the generated method comment or null if the code template is empty. The returned content is unformatted and not indented (formatting required).

Throws:

CoreException - Thrown when the evaluation of the code template fails.

getMethodComment

public static String getMethodComment(ICompilationUnit cu,
                                      String declaringTypeName,
                                      String methodName,
                                      String[] paramNames,
                                      String[] excTypeSig,
                                      String retTypeSig,
                                      IMethod overridden,
                                      String lineDelimiter)
                               throws CoreException

Returns the comment for a method or constructor using the comment code templates (constructor / method / overriding method). null is returned if the template is empty.

The returned string is unformatted and not indented.

Exception types and return type are in signature notation. e.g. a source method declared as public void foo(String text, int length) would return the array {"QString;","I"} as parameter types. See Signature.

Parameters:

cu - The compilation unit to which the method belongs. The compilation unit does not need to exist.

declaringTypeName - Name of the type to which the method belongs. For inner types the name must be qualified and include the outer types names (dot separated). See IType.getTypeQualifiedName(char).

methodName - Name of the method.

paramNames - Names of the parameters for the method.

excTypeSig - Thrown exceptions (Signature notation).

retTypeSig - Return type (Signature notation) or null for constructors.

overridden - The method that will be overridden by the created method or null for non-overriding methods. If not null, the method must exist.

lineDelimiter - The line delimiter to be used.

Returns:

Returns the constructed comment or null if the comment code template is empty. The returned content is unformatted and not indented (formatting required).

Throws:

CoreException - Thrown when the evaluation of the code template fails.

getMethodComment

public static String getMethodComment(ICompilationUnit cu,
                                      String declaringTypeName,
                                      String methodName,
                                      String[] paramNames,
                                      String[] excTypeSig,
                                      String retTypeSig,
                                      String[] typeParameterNames,
                                      IMethod overridden,
                                      String lineDelimiter)
                               throws CoreException

Returns the comment for a method or constructor using the comment code templates (constructor / method / overriding method). null is returned if the template is empty.

The returned string is unformatted and not indented.

Exception types and return type are in signature notation. e.g. a source method declared as public void foo(String text, int length) would return the array {"QString;","I"} as parameter types. See Signature.

Parameters:

cu - The compilation unit to which the method belongs. The compilation unit does not need to exist.

declaringTypeName - Name of the type to which the method belongs. For inner types the name must be qualified and include the outer types names (dot separated). See IType.getTypeQualifiedName(char).

methodName - Name of the method.

paramNames - Names of the parameters for the method.

excTypeSig - Thrown exceptions (Signature notation).

retTypeSig - Return type (Signature notation) or null for constructors.

typeParameterNames - Names of the type parameters for the method.

overridden - The method that will be overridden by the created method or null for non-overriding methods. If not null, the method must exist.

lineDelimiter - The line delimiter to be used.

Returns:

Returns the constructed comment or null if the comment code template is empty. The returned content is unformatted and not indented (formatting required).

Throws:

CoreException - Thrown when the evaluation of the code template fails.

Since:

3.1

getMethodComment

public static String getMethodComment(IMethod method,
                                      IMethod overridden,
                                      String lineDelimiter)
                               throws CoreException

Returns the comment for a method or constructor using the comment code templates (constructor / method / overriding method). null is returned if the template is empty.

The returned string is unformatted and not indented.

Parameters:

method - The method to be documented. The method must exist.

overridden - The method that will be overridden by the created method or null for non-overriding methods. If not null, the method must exist.

lineDelimiter - The line delimiter to be used.

Returns:

Returns the constructed comment or null if the comment code template is empty. The returned string is unformatted and and has no indent (formatting required).

Throws:

CoreException - Thrown when the evaluation of the code template fails.

getMethodComment

public static String getMethodComment(ICompilationUnit cu,
                                      String declaringTypeName,
                                      MethodDeclaration decl,
                                      boolean isDeprecated,
                                      String overriddenMethodName,
                                      String overriddenMethodDeclaringTypeName,
                                      String[] overriddenMethodParameterTypeNames,
                                      String lineDelimiter)
                               throws CoreException

Returns the comment for a method or constructor using the comment code templates (constructor / method / overriding method). null is returned if the template is empty.

The returned string is unformatted and not indented.

Parameters:

cu - The compilation unit to which the method belongs. The compilation unit does not need to exist.

declaringTypeName - Name of the type to which the method belongs. For inner types the name must be qualified and include the outer types names (dot separated). See IType.getTypeQualifiedName(char).

decl - The MethodDeclaration AST node that will be added as new method. The node does not need to exist in an AST (no parent needed) and does not need to resolve. See AST.newMethodDeclaration() for how to create such a node.

isDeprecated - If set, the method is deprecated

overriddenMethodName - If a method is overridden, the simple name of the overridden method, or null if no method is overridden.

overriddenMethodDeclaringTypeName - If a method is overridden, the fully qualified type name of the overridden method's declaring type, or null if no method is overridden.

overriddenMethodParameterTypeNames - If a method is overridden, the fully qualified parameter type names of the overridden method, or null if no method is overridden.

lineDelimiter - The line delimiter to be used.

Returns:

Returns the constructed comment or null if the comment code template is empty. The returned string is unformatted and and has no indent (formatting required).

Throws:

CoreException - Thrown when the evaluation of the code template fails.

Since:

3.2

getMethodBodyContent

public static String getMethodBodyContent(ICompilationUnit cu,
                                          String declaringTypeName,
                                          String methodName,
                                          boolean isConstructor,
                                          String bodyStatement,
                                          String lineDelimiter)
                                   throws CoreException

Returns the content of the body for a method or constructor using the method body templates. null is returned if the template is empty.

The returned string is unformatted and not indented.

Parameters:

cu - The compilation unit to which the method belongs. The compilation unit does not need to exist.

declaringTypeName - Name of the type to which the method belongs. For inner types the name must be qualified and include the outer types names (dot separated). See IType.getTypeQualifiedName(char).

methodName - Name of the method.

isConstructor - Defines if the created body is for a constructor.

bodyStatement - The code to be entered at the place of the variable ${body_statement}.

lineDelimiter - The line delimiter to be used.

Returns:

Returns the constructed body content or null if the comment code template is empty. The returned string is unformatted and and has no indent (formatting required).

Throws:

CoreException - Thrown when the evaluation of the code template fails.

getGetterMethodBodyContent

public static String getGetterMethodBodyContent(ICompilationUnit cu,
                                                String declaringTypeName,
                                                String methodName,
                                                String fieldName,
                                                String lineDelimiter)
                                         throws CoreException

Returns the content of body for a getter method using the getter method body template. null is returned if the template is empty.

The returned string is unformatted and not indented.

Parameters:

cu - The compilation unit to which the method belongs. The compilation unit does not need to exist.

declaringTypeName - Name of the type to which the method belongs. For inner types the name must be qualified and include the outer types names (dot separated). See IType.getTypeQualifiedName(char).

methodName - The name of the getter method.

fieldName - The name of the field to get in the getter method, corresponding to the template variable for ${field}.

lineDelimiter - The line delimiter to be used.

Returns:

Returns the constructed body content or null if the comment code template is empty. The returned string is unformatted and and has no indent (formatting required).

Throws:

CoreException - Thrown when the evaluation of the code template fails.

Since:

3.0

getSetterMethodBodyContent

public static String getSetterMethodBodyContent(ICompilationUnit cu,
                                                String declaringTypeName,
                                                String methodName,
                                                String fieldName,
                                                String paramName,
                                                String lineDelimiter)
                                         throws CoreException

Returns the content of body for a setter method using the setter method body template. null is returned if the template is empty.

The returned string is unformatted and not indented.

Parameters:

cu - The compilation unit to which the method belongs. The compilation unit does not need to exist.

declaringTypeName - Name of the type to which the method belongs. For inner types the name must be qualified and include the outer types names (dot separated). See IType.getTypeQualifiedName(char).

methodName - The name of the setter method.

fieldName - The name of the field to be set in the setter method, corresponding to the template variable for ${field}.

paramName - The name of the parameter passed to the setter method, corresponding to the template variable for $(param).

lineDelimiter - The line delimiter to be used.

Returns:

Returns the constructed body content or null if the comment code template is empty. The returned string is unformatted and and has no indent (formatting required).

Throws:

CoreException - Thrown when the evaluation of the code template fails.

Since:

3.0

getGetterComment

public static String getGetterComment(ICompilationUnit cu,
                                      String declaringTypeName,
                                      String methodName,
                                      String fieldName,
                                      String fieldType,
                                      String bareFieldName,
                                      String lineDelimiter)
                               throws CoreException

Returns the comment for a getter method using the getter comment template. null is returned if the template is empty.

The returned string is unformatted and not indented.

Parameters:

cu - The compilation unit to which the method belongs. The compilation unit does not need to exist.

declaringTypeName - Name of the type to which the method belongs. For inner types the name must be qualified and include the outer types names (dot separated). See IType.getTypeQualifiedName(char).

methodName - Name of the method.

fieldName - Name of the field to get.

fieldType - The type of the field to get.

bareFieldName - The field name without prefix or suffix.

lineDelimiter - The line delimiter to be used.

Returns:

Returns the generated getter comment or null if the code template is empty. The returned content is not indented.

Throws:

CoreException - Thrown when the evaluation of the code template fails.

Since:

3.0

getSetterComment

public static String getSetterComment(ICompilationUnit cu,
                                      String declaringTypeName,
                                      String methodName,
                                      String fieldName,
                                      String fieldType,
                                      String paramName,
                                      String bareFieldName,
                                      String lineDelimiter)
                               throws CoreException

Returns the comment for a setter method using the setter method body template. null is returned if the template is empty.

The returned string is unformatted and not indented.

Parameters:

cu - The compilation unit to which the method belongs. The compilation unit does not need to exist.

declaringTypeName - Name of the type to which the method belongs. For inner types the name must be qualified and include the outer types names (dot separated). See IType.getTypeQualifiedName(char).

methodName - Name of the method.

fieldName - Name of the field that is set.

fieldType - The type of the field that is to set.

paramName - The name of the parameter that used to set.

bareFieldName - The field name without prefix or suffix.

lineDelimiter - The line delimiter to be used.

Returns:

Returns the generated setter comment or null if the code template is empty. The returned comment is not indented.

Throws:

CoreException - Thrown when the evaluation of the code template fails.

Since:

3.0