oracle.javatools.parser.java.v2
Class SourceFactory

java.lang.Object
  oracle.javatools.parser.java.v2.SourceFactory

All Implemented Interfaces:

JavaConstants, JavadocTokens, JavaErrors, JavaOperators, JavaPreferences, JavaTokens

public abstract class SourceFactory
extends java.lang.Object
implements JavaConstants, JavadocTokens

The factory class for SourceElements.

SourceFactory is an abstract class because of the static methods named createSourceFile here because interfaces can't have static methods. Besides the createSourceFile methods, JavaFactory should be treated like an interface.

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.javatools.parser.java.v2.JavaPreferences

JavaPreferences.MemberOrder

Field Summary

Fields inherited from interface oracle.javatools.parser.java.v2.JavaConstants

ACC_ABSTRACT, ACC_ANNOTATION, ACC_BRIDGE, ACC_ENUM, ACC_FINAL, ACC_INTERFACE, ACC_NATIVE, ACC_none, ACC_PRIVATE, ACC_PROTECTED, ACC_PUBLIC, ACC_STATIC, ACC_STRICTFP, ACC_SUPER, ACC_SYNCHRONIZED, ACC_SYNTHETIC, ACC_TRANSIENT, ACC_VARARGS, ACC_VOLATILE, ACCX_DEPRECATED, ACCX_HIDDEN, ARRAY_implements, BOUND_EXTENDS, BOUND_NARROW, BOUND_NONE, BOUND_SUPER, ELEM_ANNOTATION, ELEM_base, ELEM_CLASS, ELEM_COMPONENT, ELEM_EXPRESSION, ELEM_FIELD, ELEM_FILE, ELEM_IMPORT, ELEM_invalid, ELEM_LOCAL_VARIABLE, ELEM_max, ELEM_METHOD, ELEM_NOTHING, ELEM_PACKAGE, ELEM_SELF_VARIABLE, ELEM_STATEMENT_LABEL, ELEM_TMP_VARIABLE, ELEM_TYPE_VARIABLE, ELEM_WILDCARD_TYPE, ELEM_words, EMPTY_OBJECT_ARRAY, EMPTY_STRING_ARRAY, FOR_ENHANCED, FOR_EXPRESSION, FOR_VARIABLE_D, kEmptyCollection, opt2srcTable, PACKAGE_INFO, PRIMITIVE_autoboxes, PRIMITIVE_binary, PRIMITIVE_BOOLEAN, PRIMITIVE_BYTE, PRIMITIVE_CHAR, PRIMITIVE_descriptors, PRIMITIVE_DOUBLE, PRIMITIVE_FLOAT, PRIMITIVE_INT, PRIMITIVE_invalid, PRIMITIVE_LONG, PRIMITIVE_max, PRIMITIVE_NULL, PRIMITIVE_SHORT, PRIMITIVE_tokens, PRIMITIVE_unary, PRIMITIVE_VOID, SRC_ANNOTATION, SRC_base, SRC_BLOCK, SRC_CATCH_PARAMETER, SRC_CLASS, SRC_CLASS_BODY, SRC_CLASS_INITIALIZER, SRC_CONSTRUCTOR_D, SRC_DOC_base, SRC_DOC_BLOCK_TAG, SRC_DOC_COMMENT, SRC_DOC_DESCRIPTION, SRC_DOC_INLINE_TAG, SRC_DOC_max, SRC_DOC_REFERENCE, SRC_DOC_TAG_NAME, SRC_DOC_TEXT, SRC_ENUM_CONSTANT_D, SRC_ERROR, SRC_EXPR_ANNOTATION, SRC_EXPR_ARRAY_ACCESS, SRC_EXPR_ASSIGNMENT, SRC_EXPR_base, SRC_EXPR_DOT, SRC_EXPR_INFIX, SRC_EXPR_LIST, SRC_EXPR_LITERAL, SRC_EXPR_max, SRC_EXPR_METHOD_CALL, SRC_EXPR_NEW_ARRAY, SRC_EXPR_NEW_CLASS, SRC_EXPR_QUESTION, SRC_EXPR_SIMPLE_NAME, SRC_EXPR_TYPE, SRC_EXPR_TYPECAST, SRC_EXPR_UNARY, SRC_EXPR_WRAPPER, SRC_FIELD_D, SRC_FIELD_VARIABLE, SRC_FILE, SRC_FORMAL_PARAMETER, SRC_FORMAL_PARAMETER_LIST, SRC_IMPORT_D, SRC_INTERFACES_CLAUSE, SRC_invalid, SRC_LABEL, SRC_LEX_base, SRC_LEX_BLANKLINE, SRC_LEX_COMMENT, SRC_LEX_max, SRC_LEX_SQLJ, SRC_LOCAL_VARIABLE, SRC_LOCAL_VARIABLE_D, SRC_max, SRC_METHOD_D, SRC_NAME, SRC_PACKAGE_D, SRC_STMT_ASSERT, SRC_STMT_base, SRC_STMT_BLOCK, SRC_STMT_BREAK, SRC_STMT_CATCH, SRC_STMT_CONTINUE, SRC_STMT_DO, SRC_STMT_ELSE, SRC_STMT_EMPTY, SRC_STMT_EXPRESSION, SRC_STMT_FINALLY, SRC_STMT_FOR, SRC_STMT_IF, SRC_STMT_max, SRC_STMT_RETURN, SRC_STMT_SWITCH, SRC_STMT_SYNCH, SRC_STMT_THROW, SRC_STMT_TRY, SRC_STMT_WHILE, SRC_SUPERCLASS_CLAUSE, SRC_SWITCH_LABEL, SRC_THROWS_CLAUSE, SRC_TYPE_ARGUMENT, SRC_TYPE_PARAMETER, SRC_TYPE_REF, SRC_words, TY_ANNOTATE, TY_CLASS, TY_ENUM, TY_INTERFACE, TY_invalid, TY_max, TY_words

Fields inherited from interface oracle.javatools.parser.java.v2.JavaErrors

ERROR_ABSTRACT_CLASS, ERROR_AMBIGUOUS_IMPORT, ERROR_AMBIGUOUS_REF, ERROR_ASSERT_IDENTIFIER, ERROR_base, ERROR_BREAK_OUTSIDE_SWITCH_OR_LOOP, ERROR_CANCELLED, ERROR_CANT_ASSIGN, ERROR_CANT_EXTEND_ENUM, ERROR_CANT_EXTEND_FINAL, ERROR_CANT_EXTEND_INTERFACE, ERROR_CANT_IMPLEMENT_CLASS, ERROR_CANT_TYPECAST, ERROR_CATEGORY_ALL, ERROR_CATEGORY_COMPILE, ERROR_CATEGORY_PARSE, ERROR_CATEGORY_SCAN, ERROR_CATEGORY_unclassified, ERROR_CHECK_EXCEPTION, ERROR_CLASS_CIRCULARITY, ERROR_COMPILE_base, ERROR_COMPILE_GENERIC, ERROR_COMPILE_max, ERROR_CONSTRUCTOR_NAME, ERROR_CONTINUE_OUTSIDE_OF_LOOP, ERROR_DUPLICATE, ERROR_EMPTY_CHAR_LITERAL, ERROR_EMPTY_EXPRESSION, ERROR_EXPECTING_ONE, ERROR_EXPECTING_TWO, ERROR_EXPECTING_TYPE, ERROR_EXTENDS_NOT_ALLOWED, ERROR_EXTENDS_TOO_MANY, ERROR_FORWARD_REFERENCE, ERROR_ILLEGAL_ANNOTATION, ERROR_ILLEGAL_DEFAULT, ERROR_ILLEGAL_LABEL, ERROR_ILLEGAL_START_OF_EXPR, ERROR_ILLEGAL_TYPE_PARAMETERS, ERROR_ILLEGAL_VARARGS, ERROR_IMPLEMENTS_NOT_ALLOWED, ERROR_IMPORT_NOT_FOUND, ERROR_INTERNAL, ERROR_INVALID_CHAR_LITERAL, ERROR_INVALID_ESCAPE_SEQUENCE, ERROR_INVALID_EXPR_STMT, ERROR_INVALID_NAME, ERROR_INVALID_OPERATION, ERROR_INVALID_STRING_LITERAL, ERROR_INVALID_SUPERTYPE, ERROR_keys, ERROR_LONE_CATCH, ERROR_LONE_ELSE, ERROR_LONE_FINALLY, ERROR_LONE_TRY, ERROR_max, ERROR_MEMBER_NOT_FOUND, ERROR_METHOD_NOT_FOUND, ERROR_MISSING_CASE_OR_DEFAULT_LABEL, ERROR_MISSING_CONDITION, ERROR_MISSING_METHOD_BODY, ERROR_MODIFIER_REPEATED, ERROR_MULTIPLE_COMPONENTS, ERROR_NAME_NOT_FOUND, ERROR_none, ERROR_NOT_ACCESSIBLE, ERROR_NOT_ANNOTATION_TYPE, ERROR_NOT_ASSIGNABLE, ERROR_NOT_GENERIC_TYPE, ERROR_NOT_IMPLEMENTED_YET, ERROR_NOT_THROWABLE, ERROR_NUMBER_FORMAT, ERROR_NUMERIC_OVERFLOW, ERROR_NUMERIC_UNDERFLOW, ERROR_ONLY_STATIC_ACCESS, ERROR_PARSE_base, ERROR_PARSE_GENERIC, ERROR_PARSE_max, ERROR_REQUIRE_ARRAY, ERROR_REQUIRE_BLOCK, ERROR_REQUIRE_FINAL, ERROR_REQUIRE_OBJECT, ERROR_REQUIRE_OUTER_CLASS, ERROR_SCAN_base, ERROR_SCAN_GENERIC, ERROR_SCAN_max, ERROR_TYPE_ARGUMENT_MISMATCH, ERROR_TYPE_IS_NOT_AUTOCLOSEABLE, ERROR_TYPE_IS_NOT_DISJUNCTIVE, ERROR_TYPE_NOT_ALLOWED, ERROR_TYPE_NOT_FOUND, ERROR_UNEXPECTED, ERROR_UNKNOWN, ERROR_VOID_RETURN, ERROR_warnings, ERROR_words, SEVERITY_ERROR, SEVERITY_FATAL, SEVERITY_LINT, SEVERITY_WARNING, SEVERITY_ZERO, WARNING_AMBIGUOUS_DOC_REFERENCE, WARNING_ASSERT_IDENTIFIER, WARNING_DOC_REFERENCE_NOT_FOUND, WARNING_IMPORT_UNUSED, WARNING_INVALID_NAME, WARNING_METHOD_NAME

Fields inherited from interface oracle.javatools.parser.java.v2.JavaOperators

OPT_ADD, OPT_ADDASG, OPT_AND, OPT_ANNOTATION, OPT_ARRAYCONST, OPT_ASG, OPT_base, OPT_BITAND, OPT_BITANDASG, OPT_BITNOT, OPT_BITOR, OPT_BITORASG, OPT_BITXOR, OPT_BITXORASG, OPT_CLASS_LITERAL, OPT_COND, OPT_DEREF, OPT_DIV, OPT_DIVASG, OPT_DOT, OPT_EQ, OPT_GE, OPT_GT, OPT_INSTANCEOF, OPT_invalid, OPT_INVOKE, OPT_LE, OPT_LIST, OPT_LITERAL, OPT_LSH, OPT_LSHASG, OPT_LT, OPT_max, OPT_MINUS, OPT_MINUSASG, OPT_MOD, OPT_MODASG, OPT_MUL, OPT_MULASG, OPT_NEGATIVE, OPT_NESTEXP, OPT_NEWARRAY, OPT_NEWOBJECT, OPT_NOT, OPT_NOTEQ, OPT_OR, OPT_POSITIVE, OPT_POSTDEC, OPT_POSTINC, OPT_precedence, OPT_PREDEC, OPT_PREINC, OPT_QUALIFIED_SUPER, OPT_QUALIFIED_THIS, OPT_RSH, OPT_RSHASG, OPT_SIMPLE_NAME, OPT_tokens, OPT_TYPE, OPT_TYPECAST, OPT_URSH, OPT_URSHASG, OPT_words

Fields inherited from interface oracle.javatools.parser.java.v2.JavaTokens

DW_values, DW_words, J2SE_13, J2SE_14, J2SE_15, J2SE_16, J2SE_17, J2SE_MAX, J2SE_MIN, KW_ABSTRACT, KW_ASSERT, KW_base, KW_BOOLEAN, KW_BREAK, KW_BYTE, KW_CASE, KW_CATCH, KW_CHAR, KW_CLASS, KW_CONST, KW_CONTINUE, KW_DEFAULT, KW_DO, KW_DOUBLE, KW_ELSE, KW_ENUM, KW_EXTENDS, KW_FINAL, KW_FINALLY, KW_FLOAT, KW_FOR, KW_GOTO, KW_IF, KW_IMPLEMENTS, KW_IMPORT, KW_INSTANCEOF, KW_INT, KW_INTERFACE, KW_j2se13_max, KW_j2se14_max, KW_j2se15_max, KW_j2se16_max, KW_LONG, KW_max, KW_NATIVE, KW_NEW, KW_PACKAGE, KW_PRIVATE, KW_PROTECTED, KW_PUBLIC, KW_RETURN, KW_SHORT, KW_STATIC, KW_STRICTFP, KW_SUPER, KW_SWITCH, KW_SYNCHRONIZED, KW_THIS, KW_THROW, KW_THROWS, KW_TRANSIENT, KW_TRY, KW_VOID, KW_VOLATILE, KW_WHILE, KW_words, OP_AND_ASG, OP_ASG, OP_AT, OP_base, OP_BINAND, OP_binary, OP_BINNOT, OP_BINOR, OP_BINXOR, OP_COLON, OP_COMMA, OP_DEC, OP_DIV, OP_DIV_ASG, OP_DOT, OP_ELLIPSIS, OP_EQ, OP_GE, OP_GT, OP_HASH, OP_INC, OP_LBRACE, OP_LBRACKET, OP_LE, OP_LOGAND, OP_LOGNOT, OP_LOGOR, OP_LPAREN, OP_LSH, OP_LSH_ASG, OP_LT, OP_max, OP_MINUS, OP_MINUS_ASG, OP_MOD, OP_MOD_ASG, OP_MUL, OP_MUL_ASG, OP_NE, OP_OR_ASG, OP_PLUS, OP_PLUS_ASG, OP_prefix, OP_QUES, OP_RBRACE, OP_RBRACKET, OP_RPAREN, OP_RSH, OP_RSH_ASG, OP_SEMI, OP_URSH, OP_URSH_ASG, OP_words, OP_XOR_ASG, TK_BOOLEAN_LITERAL, TK_CHAR_LITERAL, TK_DOC_COMMENT, TK_DOUBLE_LITERAL, TK_EOF, TK_FLOAT_LITERAL, TK_IDENTIFIER, TK_INT_LITERAL, TK_LITERAL_base, TK_LITERAL_max, TK_LONG_LITERAL, TK_max, TK_MULTI_COMMENT, TK_NULL_LITERAL, TK_SINGLE_COMMENT, TK_SQLJ, TK_STRING_LITERAL, TK_WHITESPACE

Fields inherited from interface oracle.javatools.parser.java.v2.JavaPreferences

BLANKLINES_AFTER_LAST_MEMBER, BLANKLINES_BEFORE_DOC_COMMENT, BLANKLINES_BEFORE_FIELD, BLANKLINES_BEFORE_FIRST_CLASS, BLANKLINES_BEFORE_FIRST_MEMBER, BLANKLINES_BEFORE_MEMBER_CLASS, BLANKLINES_BEFORE_METHOD, BLANKLINES_EMPTY_ANONYMOUS, BLANKLINES_EMPTY_BLOCK, BLANKLINES_EMPTY_CLASS, BLANKLINES_EMPTY_METHOD, BLANKLINES_IMPORTS_AFTER, BLANKLINES_PACKAGE_AFTER, BLANKLINES_PRESERVE_COUNT, CLONE_QUALIFIES_TYPES, FALSE, IGNORED_I, IGNORED_Z, IMPORT_GROUP_IMPORTS, IMPORT_GROUP_PACKAGE_DEPTH, IMPORT_INNER_CLASS_NAME, IMPORT_NARROW_MEMBERS_THRESHOLD, IMPORT_NARROW_THRESHOLD, INDENT_BLOCK_CHILDREN, INDENT_CLASS_MEMBERS, INDENT_CONTROL_BLOCKS, INDENT_NUM_SPACES, INDENT_REPLACE_WITH_TABS, INDENT_SWITCH_CASES, INDENT_TAB_SIZE, INTEGER_ALWAYS_WRAP, INTEGER_NEVER_WRAP, INTEGER_WRAP_IF_LONG, MEMBER_ORDER, NEWLINE_AFTER_SWITCH_CASE, NEWLINE_ARRAY_BRACES, NEWLINE_BLOCK_BRACES, NEWLINE_CATCH, NEWLINE_CLASS_BRACES, NEWLINE_ELSE, NEWLINE_EXTENDS, NEWLINE_FINALLY, NEWLINE_IMPLEMENTS, NEWLINE_METHOD_BRACES, NEWLINE_THROWS, NEWLINE_WHILE, ONE, PREFERENCES_base, PREFERENCES_defaults, PREFERENCES_keys, PREFERENCES_max, PREFERENCES_sun, SPACE_ARGUMENTS_BEFORE, SPACE_ASSIGN_AROUND, SPACE_BINARYOP_AROUND, SPACE_BRACES_AROUND, SPACE_BRACKETS_WITHIN, SPACE_COLON_AFTER, SPACE_COLON_BEFORE, SPACE_COMMA_AFTER, SPACE_COMMA_BEFORE, SPACE_KEYWORD_AFTER, SPACE_OPENBRACE_BEFORE, SPACE_PARAMETERS_BEFORE, SPACE_PARENS_WITHIN, SPACE_QUESTION_AFTER, SPACE_QUESTION_BEFORE, SPACE_SEMICOLON_AFTER, SPACE_SEMICOLON_BEFORE, SPACE_TYPECAST_AFTER, TRI_ALWAYS_WRAP, TRI_NEVER_WRAP, TRI_WRAP_IF_LONG, TRUE, TWO, UNKNOWN_I, UNKNOWN_Z, WRAP_ALIGN, WRAP_ARRAY_CONSTANT, WRAP_BINARY_OPERATOR, WRAP_DOT_CHAIN, WRAP_EXTENDS, WRAP_FOR_STATEMENT, WRAP_INVOKE_ARGUMENTS, WRAP_LINE_WIDTH, WRAP_MODIFIERS, WRAP_PARAMETER_LIST, WRAP_QUES_OPERATOR, WRAP_THROWS, ZERO

Fields inherited from interface oracle.javatools.parser.java.v2.JavadocTokens

TAG_AUTHOR, TAG_base, TAG_CODE, TAG_DEPRECATED, TAG_DOCROOT, TAG_EXCEPTION, TAG_HIDDEN, TAG_INHERITDOC, TAG_inline, TAG_LINK, TAG_LINKPLAIN, TAG_LITERAL, TAG_max, TAG_PARAM, TAG_RETURN, TAG_SEE, TAG_SERIAL, TAG_SERIALDATA, TAG_SERIALFIELD, TAG_SINCE, TAG_THROWS, TAG_unknown, TAG_VALUE, TAG_VERSION, TAG_words, TK_DOC_base, TK_DOC_COLON, TK_DOC_COMMA, TK_DOC_DOT, TK_DOC_HASH, TK_DOC_LBRACE, TK_DOC_LINE_START, TK_DOC_LPAREN, TK_DOC_NEWLINE, TK_DOC_RBRACE, TK_DOC_RPAREN, TK_DOC_TEXT, TK_DOC_WHITESPACE

Constructor Summary

SourceFactory()

Method Summary

SourceAnnotation	createAnnotation(java.lang.String name) Creates an annotation (but not an annotation type).
abstract SourceAnnotation	createAnnotation(java.lang.String name, SourceListExpression arguments) Creates an annotation (but not an annotation type).
abstract SourceAnnotationExpression	createAnnotationExpression(SourceAnnotation a) Creates an argument list with one argument.
abstract SourceAnnotation	createAnnotationFromText(java.lang.String text) Attempts to create an annotation with the given text.
SourceListExpression	createArgumentList() Creates an argument list with one argument.
SourceListExpression	createArgumentList(SourceExpression arg) Creates an argument list with one argument.
SourceListExpression	createArgumentList(SourceExpression[] arguments) Creates an argument list.
abstract SourceArrayAccessExpression	createArrayAccess(SourceExpression lhs, SourceListExpression dereferences) Creates an array access.
abstract SourceListExpression	createArrayConstant(SourceExpression[] operands) Creates an array constant.
abstract SourceAssertStatement	createAssertStatement(SourceExpression condition, SourceExpression output) Creates an assert statement.
abstract SourceAssignmentExpression	createAssignment(int code, SourceExpression lhs, SourceExpression rhs) Creates an assignment expression.
abstract SourceLexicalBlankline	createBlankline() Creates a blank line.
SourceBlock	createBlock() Creates an empty code block.
abstract SourceBlock	createBlock(SourceElement[] elements) Creates a code block.
SourceBlock	createBlock(java.lang.String text) See createBlockFromText(java.lang.String).
abstract SourceBlockElement	createBlockElementFromText(java.lang.String text) Attempts to create a block element (i.e.
abstract SourceBlock	createBlockFromText(java.lang.String text) Attempts to create a block with the given text.
abstract SourceBlockStatement	createBlockStatement(SourceBlock block) Creates a block statement.
abstract SourceBreakStatement	createBreakStatement(java.lang.String target) Creates a break statement.
abstract SourceCatchClause	createCatchClause(SourceCatchParameter parameter, SourceBlockStatement block) Creates a catch clause for a try-catch or a try-catch-finally statement.
abstract SourceCatchClause	createCatchClause(SourceFormalParameterList parameters, SourceBlockStatement block) Deprecated. Use createCatchClause( SourceCatchParameter, SourceBlockStatement ) instead
SourceCatchClause	createCatchClause(SourceLocalVariable parameter, SourceBlockStatement block) Deprecated. This method can only create JDK6 ( or before ) compatible catch parameters. Use createCatchClause( SourceCatchParameter, SourceBlockStatement ) instead
abstract SourceCatchParameter	createCatchParameter(java.util.List types, java.lang.String name) Creates a catch clause parameter from a union of types
SourceClass	createClass(int tyKind, java.lang.String name) Creates a plain and simple ol' class.
SourceClass	createClass(int tyKind, java.lang.String name, SourceSuperclassClause superclassClause, SourceInterfacesClause interfacesClause, SourceClassBody body) Creates a class declaration.
abstract SourceClass	createClass(int tyKind, java.lang.String name, SourceTypeParameter[] tyParameters, SourceSuperclassClause superclassClause, SourceInterfacesClause interfacesClause, SourceClassBody body) Creates a class declaration.
SourceClass	createClass(java.lang.String text) See createClassFromText(java.lang.String).
SourceClassBody	createClassBody() Creates an empty class body.
SourceClassBody	createClassBody(SourceMember member) Creates an empty class body.
abstract SourceClassBody	createClassBody(SourceMember[] members) Creates a class body.
SourceNewClassExpression	createClassCreator(SourceExpression lhs, SourceTypeReference type, SourceListExpression arguments, SourceClassBody body) Deprecated. Use createNewClassExpression(SSSS).
abstract SourceClass	createClassFromText(java.lang.String text) Attempts to create a class with the given text.
abstract SourceClassInitializer	createClassInitializer(int modifiers, SourceBlock block) Creates a class initializer.
abstract SourceLexicalComment	createComment(java.lang.String text) Creates an ordinary non-javadoc comment.
SourceMethod	createConstructor(SourceFormalParameterList parameters, SourceThrowsClause throwsClause, SourceBlock block) Creates a constructor declaration.
abstract SourceMethod	createConstructor(SourceTypeParameter[] typeParameters, SourceFormalParameterList parameters, SourceThrowsClause throwsClause, SourceBlock block) Creates a constructor declaration.
abstract SourceContinueStatement	createContinueStatement(java.lang.String target) Creates a continue statement.
SourceDocBlockTag	createDocBlockTag(SourceDocTagName name) Creates a doc block tag.
SourceDocBlockTag	createDocBlockTag(SourceDocTagName name, SourceDocDescription description) Creates a doc block tag with no references.
abstract SourceDocBlockTag	createDocBlockTag(SourceDocTagName name, SourceDocReference[] references, SourceDocDescription description) Creates a doc block tag with many references.
SourceDocBlockTag	createDocBlockTag(SourceDocTagName name, SourceDocReference reference, SourceDocDescription description) Creates a doc block tag with one reference.
abstract SourceDocBlockTag	createDocBlockTagFromText(java.lang.String text) Attempts to create a doc block tag with the given text.
SourceDocReference	createDocClassReference(java.lang.String qualifiedName) Creates a doc reference with the class reference syntax.
SourceDocComment	createDocComment() Creates a doc comment, empty.
SourceDocComment	createDocComment(SourceDocDescription description) Creates a doc comment with the given description.
SourceDocComment	createDocComment(SourceDocDescription description, SourceDocBlockTag tag) Creates a doc comment with the given description and block tags.
abstract SourceDocComment	createDocComment(SourceDocDescription description, SourceDocBlockTag[] tags) Creates a doc comment with the given description and block tags.
SourceDocComment	createDocComment(java.lang.String text) See createDocCommentFromText(java.lang.String).
abstract SourceDocComment	createDocCommentFromText(java.lang.String text) Attempts to create a doc comment with the given text.
SourceDocDescription	createDocDescription() Creates a doc description, empty.
SourceDocDescription	createDocDescription(SourceDocTextFragment line) Creates a doc description with a single line of text.
abstract SourceDocDescription	createDocDescription(SourceDocTextFragment[] lines) Creates a doc description from the input lines of text.
SourceDocInlineTag	createDocInlineTag(SourceDocTagName name) Creates a doc inline tag.
SourceDocInlineTag	createDocInlineTag(SourceDocTagName name, SourceDocDescription description) Creates a doc inline tag with no references.
abstract SourceDocInlineTag	createDocInlineTag(SourceDocTagName name, SourceDocReference[] references, SourceDocDescription description) Creates a doc inline tag with many references.
SourceDocInlineTag	createDocInlineTag(SourceDocTagName name, SourceDocReference reference, SourceDocDescription description) Creates a doc inline tag with one reference.
abstract SourceDocInlineTag	createDocInlineTagFromText(java.lang.String text) Attempts to create a doc block tag with the given text.
SourceDocReference	createDocMemberReference(java.lang.String classString, java.lang.String memberName) Creates a doc reference with the member reference syntax.
abstract SourceDocReference	createDocMemberReferenceFromText(java.lang.String text) Attempts to create a doc member reference with the given text.
SourceDocReference	createDocMethodReference(java.lang.String classString, java.lang.String methodName, java.lang.String[] parameterTypes) Creates a doc reference with the method reference syntax.
abstract SourceDocReference	createDocParameterReference(java.lang.String parameterName) Creates a doc reference with the parameter syntax.
abstract SourceDocReference	createDocReference(java.lang.String classString, java.lang.String memberName, java.lang.String[] parameterTypes) Creates a doc reference.
SourceDocTagName	createDocTagName(short tag) Creates a doc tag name from the token value.
abstract SourceDocTagName	createDocTagName(java.lang.String name) Creates a doc tag name.
abstract SourceDocTextFragment	createDocTextFragment(java.lang.String text) Creates a doc text fragment.
abstract SourceDoStatement	createDoStatement(SourceExpression e, SourceStatement child) Creates a do-while statement.
abstract SourceDotExpression	createDotReference(SourceExpression lhs, java.lang.String name) Creates a dot reference.
abstract SourceElseClause	createElseClause(SourceStatement child) Creates an else clause for an if statement.
abstract SourceEmptyStatement	createEmptyStatement() Creates an empty statement.
abstract SourceEnumConstant	createEnumConstant(java.lang.String name, SourceListExpression arguments, SourceClassBody body)
abstract SourceExpression	createExpression(int code)
SourceExpression	createExpression(java.lang.String text) See createExpressionFromText(java.lang.String).
abstract SourceExpression	createExpressionFromText(java.lang.String text) Attempts to create an expression with the given text.
SourceListExpression	createExpressionList()
SourceListExpression	createExpressionList(SourceExpression argument) Creates a list expression with one element.
abstract SourceListExpression	createExpressionList(SourceExpression[] arguments) Creates a list expression.
abstract SourceExpressionStatement	createExpressionStatement(SourceExpression e) Creates an expression statement.
SourceFieldDeclaration	createFieldDeclaration(int modifiers, SourceTypeReference type, java.lang.String name) Creates a field declaration.
SourceFieldDeclaration	createFieldDeclaration(int modifiers, SourceTypeReference type, java.lang.String name, SourceExpression initializer) Creates a field declaration.
abstract SourceFieldDeclaration	createFieldDeclaration(SourceFieldVariable variable) Creates a field declaration.
SourceFieldDeclaration	createFieldDeclaration(SourceFieldVariable[] variables) Deprecated. Not implemented yet. Creates a field declaration.
SourceFieldDeclaration	createFieldDeclaration(SourceLocalVariable variable) Creates a field variable to match the local variable.
abstract SourceFieldDeclaration	createFieldDeclaration(SourceLocalVariableDeclaration locals) Creates a field declaration to match the local variable declaration.
SourceFieldDeclaration	createFieldDeclaration(SourceTypeReference type, java.lang.String name) Creates a field declaration.
SourceFieldDeclaration	createFieldDeclaration(SourceTypeReference type, java.lang.String name, SourceExpression initializer) Creates a field declaration.
SourceFieldVariable	createFieldVariable(int modifiers, SourceTypeReference type, java.lang.String name) Creates a field variable.
SourceFieldVariable	createFieldVariable(int modifiers, SourceTypeReference type, java.lang.String name, int xdimensions, SourceExpression initializer) Creates a field variable.
SourceFieldVariable	createFieldVariable(int modifiers, SourceTypeReference type, java.lang.String name, SourceExpression initializer) Creates a field variable.
abstract SourceFieldVariable	createFieldVariable(SourceLocalVariable variable) Creates a field variable to match the local variable.
SourceFieldVariable	createFieldVariable(SourceTypeReference type, java.lang.String name) Creates a field variable.
SourceFieldVariable	createFieldVariable(SourceTypeReference type, java.lang.String name, SourceExpression initializer) Creates a field variable
static SourceFile	createFile(int j2se) The SourceFile's URL and provider cookies are set to null.
abstract SourceFinallyClause	createFinallyClause(SourceBlockStatement child) Creates a finally clause for a try statement.
abstract SourceForStatement	createForEnhancedStatement(SourceLocalVariableDeclaration loopVarDecl, SourceExpression collection, SourceStatement child) Creates an enhanced-for loop.
SourceForStatement	createForEnhancedStatement(SourceLocalVariable loopVariable, SourceExpression collection, SourceStatement child) Creates an enhanced-for loop.
abstract SourceFormalParameter	createFormalParameter(SourceLocalVariable variable) Creates a formal parameter using a local variable as a template.
SourceFormalParameterList	createFormalParameterList() Creates an empty formal parameter list.
SourceFormalParameterList	createFormalParameterList(SourceFormalParameter parameter) Input parameters, if any, will be converted to be formal parameters, namely SRC_FORMAL_PARAMETER.
abstract SourceFormalParameterList	createFormalParameterList(SourceFormalParameter[] parameters) Input parameters, if any, will be converted to be formal parameters, namely SRC_FORMAL_PARAMETER.
SourceFormalParameterList	createFormalParameterList(SourceLocalVariable variable) Input parameters, if any, will be converted to be formal parameters, namely SRC_FORMAL_PARAMETER.
SourceFormalParameterList	createFormalParameterList(SourceLocalVariable[] variables) Input parameters, if any, will be converted to be formal parameters, namely SRC_FORMAL_PARAMETER.
SourceForStatement	createForStatement(SourceExpression initialization, SourceExpression condition, SourceExpression update, SourceStatement child) Convenience method.
abstract SourceForStatement	createForStatement(SourceListExpression initializations, SourceExpression condition, SourceListExpression updates, SourceStatement child) Creates a traditional for loop with no variable declarators.
abstract SourceForStatement	createForVariableStatement(SourceLocalVariableDeclaration variables, SourceExpression condition, SourceListExpression updates, SourceStatement child) Creates a traditional for loop with variable declarations.
SourceForStatement	createForVariableStatement(SourceLocalVariable variable, SourceExpression condition, SourceExpression update, SourceStatement child) Convenience method.
SourceIfStatement	createIfElseStatement(SourceExpression e, SourceStatement trueClause, SourceStatement elseClause) Creates an if-else statement.
abstract SourceIfStatement	createIfStatement(SourceExpression e, SourceStatement child) Creates an if statement.
abstract SourceIfStatement	createIfStatement(SourceExpression e, SourceStatement child, SourceElseClause clause) Creates an if or an if-else statement.
abstract SourceImport	createImportDeclaration(int modifiers, java.lang.String name)
SourceImport	createImportDeclaration(java.lang.String name)
abstract SourceInfixExpression	createInfixExpression(int code, SourceExpression[] operands) Creates an infix expression with multiple operands.
abstract SourceInfixExpression	createInfixExpression(int code, SourceExpression lhs, SourceExpression rhs) Creates an infix expression with two operands.
SourceClassInitializer	createInstanceInitializer(SourceBlock block) Creates an instance class initializer.
SourceInfixExpression	createInstanceof(SourceExpression lhs, SourceTypeReference type) Creates a new instanceof expression.
SourceInterfacesClause	createInterfacesClause(SourceTypeReference one) Creates an interfaces ("implements" on a class and "extends" on an interface) clause.
abstract SourceInterfacesClause	createInterfacesClause(SourceTypeReference[] types) Creates an interfaces ("implements" on a class and "extends" on an interface) clause.
SourceLocalVariable	createLocalVariable(int modifiers, SourceTypeReference type, java.lang.String name) Creates a local variable.
abstract SourceLocalVariable	createLocalVariable(int modifiers, SourceTypeReference type, java.lang.String name, int xdimensions, SourceExpression initializer) Creates a local variable.
SourceLocalVariable	createLocalVariable(int modifiers, SourceTypeReference type, java.lang.String name, SourceExpression initializer) Creates a local variable.
SourceLocalVariable	createLocalVariable(SourceTypeReference type, java.lang.String name) Creates a local variable.
SourceLocalVariable	createLocalVariable(SourceTypeReference type, java.lang.String name, SourceExpression initializer) Creates a local variable
SourceLocalVariableDeclaration	createLocalVariableDeclaration(int modifiers, SourceTypeReference type, java.lang.String name) Creates a local variable declaration.
SourceLocalVariableDeclaration	createLocalVariableDeclaration(int modifiers, SourceTypeReference type, java.lang.String name, SourceExpression initializer) Creates a local variable declaration.
abstract SourceLocalVariableDeclaration	createLocalVariableDeclaration(SourceLocalVariable variable) Creates a local variable declaration.
SourceLocalVariableDeclaration	createLocalVariableDeclaration(SourceLocalVariable[] variables) Deprecated. Not implemented yet. Creates a local variable declaration.
SourceLocalVariableDeclaration	createLocalVariableDeclaration(SourceTypeReference type, java.lang.String name) Creates a local variable declaration.
SourceLocalVariableDeclaration	createLocalVariableDeclaration(SourceTypeReference type, java.lang.String name, SourceExpression initializer) Creates a local variable declaration.
SourceMember	createMember(java.lang.String text) See createMemberFromText(java.lang.String).
abstract SourceMember	createMemberFromText(java.lang.String text) Attempts to create a member with the given text.
abstract SourceMethod	createMethod(SourceTypeParameter[] tyParameters, SourceTypeReference returnType, java.lang.String methodName, SourceFormalParameterList parameters, SourceThrowsClause throwsClause, SourceBlock block) Creates a method declaration.
SourceMethod	createMethod(SourceTypeReference returnType, java.lang.String methodName, SourceFormalParameterList parameters, SourceThrowsClause throwsClause, SourceBlock block) Creates a non-generic method declaration.
abstract SourceMethodCallExpression	createMethodCall(SourceExpression lhs, SourceTypeArgument[] typeArguments, java.lang.String name, SourceListExpression arguments) Creates a method call.
SourceMethodCallExpression	createMethodCall(SourceExpression lhs, java.lang.String name, SourceListExpression arguments) Creates a method call.
abstract SourceName	createName(java.lang.String name) Creates a name.
protected abstract SourceNewArrayExpression	createNewArrayExpressionImpl(SourceTypeReference type, SourceListExpression list) (Internal) Creates an array creator.
abstract SourceNewClassExpression	createNewClassExpression(SourceExpression lhs, SourceTypeReference type, SourceListExpression arguments, SourceClassBody body) Creates a class creator.
SourceNewArrayExpression	createNewInitializedArrayExpression(SourceTypeReference type, SourceListExpression arrayconst) Creates an array creator.
SourceNewArrayExpression	createNewUninitializedArrayExpression(SourceTypeReference type, SourceListExpression args) Creates an array creator.
abstract SourcePackage	createPackageDeclaration(java.lang.String name)
abstract SourceQuestionExpression	createQuestionExpression(SourceExpression one, SourceExpression two, SourceExpression three) Creates a question expression.
abstract SourceReturnStatement	createReturnStatement(SourceExpression e) Creates a return statement.
protected abstract SourceName	createSimpleName(java.lang.String name) Creates a name.
abstract SourceSimpleNameExpression	createSimpleNameExpression(java.lang.String name) Creates a simple name expression.
abstract SourceElement	createSourceElement(int kind) May NOT be used to instantiate SourceExpression's.
SourceStatement	createStatement(java.lang.String text) See createStatementFromText(java.lang.String).
abstract SourceStatement	createStatementFromText(java.lang.String text) Attempts to create a statement with the given text.
abstract SourceStatementLabel	createStatementLabel(java.lang.String name)
SourceClassInitializer	createStaticInitializer(SourceBlock block) Creates a static class initializer.
abstract SourceSuperclassClause	createSuperclassClause(SourceTypeReference superclass) Creates a superclass ("extends" on a class) clause.
abstract SourceSwitchLabel	createSwitchCaseLabel(SourceExpression e)
abstract SourceSwitchLabel	createSwitchDefaultLabel()
abstract SourceSwitchStatement	createSwitchStatement(SourceExpression e, SourceBlockStatement child) Creates a switch statement.
abstract SourceSynchStatement	createSynchronizedStatement(SourceExpression e, SourceBlockStatement child) Creates a synchronized statement.
SourceThrowsClause	createThrowsClause(SourceTypeReference exception)
abstract SourceThrowsClause	createThrowsClause(SourceTypeReference[] exceptions)
abstract SourceThrowStatement	createThrowStatement(SourceExpression e) Creates a throw statement.
abstract SourceTryStatement	createTryCatchFinallyStatement(SourceBlockStatement tryClause, SourceCatchParameter parameter, SourceBlockStatement catchClause, SourceBlockStatement finallyClause) Creates a try-catch-finally statement with a single catch clause.
abstract SourceTryStatement	createTryCatchFinallyStatement(SourceBlockStatement tryClause, SourceFormalParameterList parameters, SourceBlockStatement catchClause, SourceBlockStatement finallyClause) Deprecated. Use createTryCatchFinallyStatement( SourceBlockStatement, SourceCatchParameter, SourceBlockStatement, SourceBlockStatement instead
SourceTryStatement	createTryCatchFinallyStatement(SourceBlockStatement tryClause, SourceFormalParameter parameter, SourceBlockStatement catchClause, SourceBlockStatement finallyClause) Deprecated. Use createTryCatchFinallyStatement( SourceBlockStatement, SourceCatchParameter, SourceBlockStatement, SourceBlockStatement instead
SourceTryStatement	createTryCatchFinallyStatement(SourceBlockStatement tryClause, SourceLocalVariable parameter, SourceBlockStatement catchClause, SourceBlockStatement finallyClause) Deprecated. Use createTryCatchFinallyStatement( SourceBlockStatement, SourceCatchParameter, SourceBlockStatement, SourceBlockStatement instead
abstract SourceTryStatement	createTryCatchStatement(SourceBlockStatement tryClause, SourceCatchParameter parameter, SourceBlockStatement catchClause) Creates a try-catch statement with a single catch clause.
abstract SourceTryStatement	createTryCatchStatement(SourceBlockStatement tryClause, SourceFormalParameterList parameters, SourceBlockStatement catchClause) Deprecated. Use createTryCatchStatement( SourceBlockStatement, SourceCatchParameter, SourceBlockStatement ) instead
SourceTryStatement	createTryCatchStatement(SourceBlockStatement tryClause, SourceFormalParameter parameter, SourceBlockStatement catchClause) Deprecated. Use createTryCatchStatement( SourceBlockStatement, SourceCatchParameter, SourceBlockStatement ) instead
SourceTryStatement	createTryCatchStatement(SourceBlockStatement tryClause, SourceLocalVariable parameter, SourceBlockStatement catchClause) Deprecated. Use createTryCatchStatement( SourceBlockStatement, SourceCatchParameter, SourceBlockStatement ) instead
abstract SourceTryStatement	createTryFinallyStatement(SourceBlockStatement child, SourceBlockStatement finallyClause) Creates a try-finally statement.
abstract SourceTryStatement	createTryStatement(SourceBlockStatement tryClause, SourceCatchClause[] catchClauses, SourceFinallyClause finallyClause) Creates a try, try-catch, try-catch-finally, or a try-finally statement.
SourceTypeReference	createType(byte primitive) Creates a primitive type reference.
SourceTypeReference	createType(java.lang.String name) Creates a type reference.
SourceTypeReference	createType(java.lang.String name, int dimensions) Creates a type reference.
abstract SourceTypeArgument	createTypeArgument(int bound, SourceTypeReference type) Creates a type argument.
abstract SourceTypecastExpression	createTypecast(SourceTypeReference type, SourceExpression operand) Creates a typecast.
abstract SourceTypeExpression	createTypeExpression(SourceTypeReference type) Creates a type expression.
SourceTypeExpression	createTypeExpression(java.lang.String type) Creates a type expression.
abstract SourceTypeReference	createTypeFromText(java.lang.String text) Attempts to create a type with the given text.
protected abstract SourceTypeReference	createTypeImpl(java.lang.String name, int dimensions)
SourceTypeParameter	createTypeParameter(java.lang.String name) Creates a type parameter.
SourceTypeParameter	createTypeParameter(java.lang.String name, SourceTypeReference type) Convenience method.
abstract SourceTypeParameter	createTypeParameter(java.lang.String name, SourceTypeReference[] bounds) Creates a type parameter.
abstract SourceUnaryExpression	createUnaryExpression(int code, SourceExpression operand) Creates a unary expression.
abstract SourceWhileStatement	createWhileStatement(SourceExpression e, SourceStatement child) Creates a while statement.
abstract SourceWrapperExpression	createWrapperExpression(SourceExpression operand) Creates a wrapper expression.
abstract SourceFile	getSourceFile() Gets the source file to which this source factory is attached.

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceFactory

public SourceFactory()

Method Detail

createFile

public static SourceFile createFile(int j2se)

The SourceFile's URL and provider cookies are set to null.

Parameters:

j2se - The j2se language value to use with this SourceFile. Valid values are JavaTokens.J2SE_*.

Returns:

A newly created (and empty) SourceFile tied to a newly created, empty, and pinned TextBuffer.

getSourceFile

public abstract SourceFile getSourceFile()

Gets the source file to which this source factory is attached.

createSourceElement

public abstract SourceElement createSourceElement(int kind)

May NOT be used to instantiate SourceExpression's. Will return an unpredictable result if you try.

Parameters:

kind - Valid values are JavaConstants.SRC_* except for SRC_EXPR_*.

createExpression

public abstract SourceExpression createExpression(int code)

Parameters:

code - Valid values are JavaOperators.OPT_*.

createName

public abstract SourceName createName(java.lang.String name)

Creates a name.

Parameters:

name - Must be a valid qualified name.

Throws:

java.lang.IllegalArgumentException - if name is not a valid qualified name.

createSimpleName

protected abstract SourceName createSimpleName(java.lang.String name)

Creates a name. For internal use only.

Parameters:

name - Must be a valid simple name.

Throws:

java.lang.IllegalArgumentException - if name is not a valid simple name.

createType

public final SourceTypeReference createType(byte primitive)

Creates a primitive type reference.

Parameters:

primitive - Valid values are JavaConstants.PRIMITIVE_*.

createType

public final SourceTypeReference createType(java.lang.String name)

Creates a type reference.

Parameters:

name - Must be a valid qualified name.

Throws:

java.lang.IllegalArgumentException - if name is not a valid qualified name.

createType

public final SourceTypeReference createType(java.lang.String name,
                                            int dimensions)

Creates a type reference.

Parameters:

name - Must be a valid qualified name.

dimensions - Require non-negative.

Throws:

java.lang.IllegalArgumentException - if name is not a valid qualified name.

createTypeImpl

protected abstract SourceTypeReference createTypeImpl(java.lang.String name,
                                                      int dimensions)

createTypeArgument

public abstract SourceTypeArgument createTypeArgument(int bound,
                                                      SourceTypeReference type)

Creates a type argument.

Parameters:

bound - Assuming the type is named "T", here is what you get for the indicated value of bound.

bound	result
BOUND_NARROW	T
BOUND_EXTENDS	? extends T
BOUND_SUPER	? super T
BOUND_NONE	?

type - Ignored if bound == BOUND_NONE.

createComment

public abstract SourceLexicalComment createComment(java.lang.String text)

Creates an ordinary non-javadoc comment. May not be upgraded to a javadoc comment.

Parameters:

text - A newline will be automatically appended to whatever you pass in. Must be a comment, that is, it must be prefixed by one of: "/*", "//".

createBlankline

public abstract SourceLexicalBlankline createBlankline()

Creates a blank line.

createBlock

public final SourceBlock createBlock(java.lang.String text)

See createBlockFromText(java.lang.String).

createClass

public final SourceClass createClass(java.lang.String text)

See createClassFromText(java.lang.String).

createDocComment

public final SourceDocComment createDocComment(java.lang.String text)

See createDocCommentFromText(java.lang.String).

createExpression

public final SourceExpression createExpression(java.lang.String text)

See createExpressionFromText(java.lang.String).

createMember

public final SourceMember createMember(java.lang.String text)

See createMemberFromText(java.lang.String).

createStatement

public final SourceStatement createStatement(java.lang.String text)

See createStatementFromText(java.lang.String).

createAnnotationFromText

public abstract SourceAnnotation createAnnotationFromText(java.lang.String text)

Attempts to create an annotation with the given text.

Parameters:

text - Must include the beginning '@' character.

createBlockFromText

public abstract SourceBlock createBlockFromText(java.lang.String text)

Attempts to create a block with the given text.

Parameters:

text - Must include the start and end braces.

createBlockElementFromText

public abstract SourceBlockElement createBlockElementFromText(java.lang.String text)

Attempts to create a block element (i.e. block child) with the given text.

Parameters:

text - May be a statement, local variable declaration, or a class declaration. May NOT be a comment.

createClassFromText

public abstract SourceClass createClassFromText(java.lang.String text)

Attempts to create a class with the given text.

createDocBlockTagFromText

public abstract SourceDocBlockTag createDocBlockTagFromText(java.lang.String text)

Attempts to create a doc block tag with the given text.

Parameters:

text - Must start with '@'. A trailing newline is not required.

createDocCommentFromText

public abstract SourceDocComment createDocCommentFromText(java.lang.String text)

Attempts to create a doc comment with the given text.

Parameters:

text - Must include start with the "/**" comment beginning and end with the comment ending.

createDocInlineTagFromText

public abstract SourceDocInlineTag createDocInlineTagFromText(java.lang.String text)

Attempts to create a doc block tag with the given text.

Parameters:

text - Must start with '{' and must end with '}'.

createExpressionFromText

public abstract SourceExpression createExpressionFromText(java.lang.String text)

Attempts to create an expression with the given text.

createMemberFromText

public abstract SourceMember createMemberFromText(java.lang.String text)

Attempts to create a member with the given text. The input may be a class, field, or method declaration. The input may also be a class initializer.

createStatementFromText

public abstract SourceStatement createStatementFromText(java.lang.String text)

Attempts to create a statement with the given text.

Parameters:

text - Must be a statement of some sort. Cannot be a local variable declaration or a class declaration. Don't forget the trailing semicolon, if applicable.

createTypeFromText

public abstract SourceTypeReference createTypeFromText(java.lang.String text)

Attempts to create a type with the given text.

createDocMemberReferenceFromText

public abstract SourceDocReference createDocMemberReferenceFromText(java.lang.String text)

Attempts to create a doc member reference with the given text.

Unlike all the other createThingFromText(S) (which return null on an invalid input), if the input is invalid, the returned result will likely be non-null and will be unpredictable.

createAnnotation

public final SourceAnnotation createAnnotation(java.lang.String name)

Creates an annotation (but not an annotation type).

Parameters:

name - Must be a valid qualified name.

Throws:

java.lang.IllegalArgumentException - if name is not a valid qualified name.

createAnnotation

public abstract SourceAnnotation createAnnotation(java.lang.String name,
                                                  SourceListExpression arguments)

Creates an annotation (but not an annotation type).

Parameters:

name - Must be a valid qualified name.

arguments - Null indicates no argument list.

Throws:

java.lang.IllegalArgumentException - if name is not a valid qualified name.

createTypeParameter

public final SourceTypeParameter createTypeParameter(java.lang.String name)

Creates a type parameter.

Parameters:

name - Must be a valid simple name.

Throws:

java.lang.IllegalArgumentException - if name is not a valid simple name.

createTypeParameter

public final SourceTypeParameter createTypeParameter(java.lang.String name,
                                                     SourceTypeReference type)

Convenience method. Creates a type parameter.

Parameters:

name - Must be a valid simple name.

type - Require non-null.

Throws:

java.lang.IllegalArgumentException - if name is not a valid simple name.

createTypeParameter

public abstract SourceTypeParameter createTypeParameter(java.lang.String name,
                                                        SourceTypeReference[] bounds)

Creates a type parameter.

Parameters:

name - Must be a valid simple name.

bounds - Null means no bounds.

Throws:

java.lang.IllegalArgumentException - if name is not a valid simple name.

createPackageDeclaration

public abstract SourcePackage createPackageDeclaration(java.lang.String name)

Parameters:

name - Must be a valid qualified name.

Throws:

java.lang.IllegalArgumentException - if name is not a valid qualified name.

createImportDeclaration

public final SourceImport createImportDeclaration(java.lang.String name)

Parameters:

name - Must be a valid import string.

Throws:

java.lang.IllegalArgumentException - if name is not a valid import string.

createImportDeclaration

public abstract SourceImport createImportDeclaration(int modifiers,
                                                     java.lang.String name)

Parameters:

modifiers - Valid values are ACC_none or ACC_STATIC.

name - Must be a valid import string.

Throws:

java.lang.IllegalArgumentException - if name is not a valid import string.

createClass

public final SourceClass createClass(int tyKind,
                                     java.lang.String name)

Creates a plain and simple ol' class.

Parameters:

tyKind - Valid values are JavaConstants.TY_*.

name - Must be a valid simple name.

Throws:

java.lang.IllegalArgumentException - if name is not a valid simple name.

createClass

public final SourceClass createClass(int tyKind,
                                     java.lang.String name,
                                     SourceSuperclassClause superclassClause,
                                     SourceInterfacesClause interfacesClause,
                                     SourceClassBody body)

Creates a class declaration. Useful for those unfamiliar with jdk 1.5.

Parameters:

tyKind - Valid values are JavaConstants.TY_*.

name - Must be a valid simple name.

superclassClause - Null means an empty superclass clause.

interfacesClause - Null means an interfaces empty clause.

body - Null indicates an empty body.

Throws:

java.lang.IllegalArgumentException - if name is not a valid simple name.

createClass

public abstract SourceClass createClass(int tyKind,
                                        java.lang.String name,
                                        SourceTypeParameter[] tyParameters,
                                        SourceSuperclassClause superclassClause,
                                        SourceInterfacesClause interfacesClause,
                                        SourceClassBody body)

Creates a class declaration.

Parameters:

tyKind - Valid values are JavaConstants.TY_*.

name - Must be a valid simple name.

tyParameters - Null means no type parameters.

superclassClause - Null means an empty superclass clause.

interfacesClause - Null means an interfaces empty clause.

body - Null indicates an empty body.

Throws:

java.lang.IllegalArgumentException - if name is not a valid simple name.

createConstructor

public final SourceMethod createConstructor(SourceFormalParameterList parameters,
                                            SourceThrowsClause throwsClause,
                                            SourceBlock block)

Creates a constructor declaration. To make this constructor a variable arguments method, use: SourceMethod.addModifiers( JavaConstants.ACC_VARARGS )

Parameters:

parameters - Null indicates an empty parameter list.

throwsClause - Null indicates no throws clause.

block - Null indicates no an empty block.

createConstructor

public abstract SourceMethod createConstructor(SourceTypeParameter[] typeParameters,
                                               SourceFormalParameterList parameters,
                                               SourceThrowsClause throwsClause,
                                               SourceBlock block)

Creates a constructor declaration. To make this constructor a variable arguments method, use: SourceMethod.addModifiers( JavaConstants.ACC_VARARGS )

Parameters:

parameters - Null indicates an empty parameter list.

throwsClause - Null indicates no throws clause.

block - Null indicates no an empty block.

createMethod

public final SourceMethod createMethod(SourceTypeReference returnType,
                                       java.lang.String methodName,
                                       SourceFormalParameterList parameters,
                                       SourceThrowsClause throwsClause,
                                       SourceBlock block)

Creates a non-generic method declaration. To make this method a variable arguments method, use: SourceMethod.addModifiers( JavaConstants.ACC_VARARGS )

Parameters:

returnType - Null indicates a void return type.

methodName - Must be a valid simple name.

parameters - Null indicates an empty parameter list.

throwsClause - Null indicates no throws clause.

block - Null indicates no block.

Throws:

java.lang.IllegalArgumentException - if name is not a valid simple name.

createMethod

public abstract SourceMethod createMethod(SourceTypeParameter[] tyParameters,
                                          SourceTypeReference returnType,
                                          java.lang.String methodName,
                                          SourceFormalParameterList parameters,
                                          SourceThrowsClause throwsClause,
                                          SourceBlock block)

Creates a method declaration. To make this method a variable arguments method, use: SourceMethod.addModifiers( JavaConstants.ACC_VARARGS )

Parameters:

tyParameters - Require non-null. For none, use SourceTypeParameter.EMPTY_ARRAY.

returnType - Null indicates a void return type.

methodName - Must be a valid simple name.

parameters - Null indicates an empty parameter list.

throwsClause - Null indicates no throws clause.

block - Null indicates no block.

Throws:

java.lang.IllegalArgumentException - if name is not a valid simple name.

createEnumConstant

public abstract SourceEnumConstant createEnumConstant(java.lang.String name,
                                                      SourceListExpression arguments,
                                                      SourceClassBody body)

Parameters:

name - Must be a valid simple name.

arguments - Null indicates none.

body - Null indicates none.

Throws:

java.lang.IllegalArgumentException - if name is not a valid simple name.

createInstanceInitializer

public final SourceClassInitializer createInstanceInitializer(SourceBlock block)

Creates an instance class initializer.

Parameters:

block - Null indicates an empty block.

createStaticInitializer

public final SourceClassInitializer createStaticInitializer(SourceBlock block)

Creates a static class initializer.

Parameters:

block - Null indicates an empty block.

createClassInitializer

public abstract SourceClassInitializer createClassInitializer(int modifiers,
                                                              SourceBlock block)

Creates a class initializer.

Parameters:

block - Null indicates an empty block.

modifiers - Valid values are ACC_none and ACC_STATIC.

createFieldVariable

public abstract SourceFieldVariable createFieldVariable(SourceLocalVariable variable)

Creates a field variable to match the local variable. Note, this function does not convert the local variable. Instead, this function creates a field that uses the variable's type and name. The input local variable should be discarded after this.

Parameters:

variable - Require non-null.

createFieldDeclaration

public final SourceFieldDeclaration createFieldDeclaration(SourceLocalVariable variable)

Creates a field variable to match the local variable. Note, this function does not convert the local variable. Instead, this function creates a field that uses the variable's type and name. The input local variable should be discarded after this.

Parameters:

variable - Require non-null.

createFieldDeclaration

public abstract SourceFieldDeclaration createFieldDeclaration(SourceFieldVariable variable)

Creates a field declaration.

Parameters:

variable - Require non-null.

createFieldDeclaration

@Deprecated
public final SourceFieldDeclaration createFieldDeclaration(SourceFieldVariable[] variables)

Deprecated. Not implemented yet. Creates a field declaration.

createFieldDeclaration

public abstract SourceFieldDeclaration createFieldDeclaration(SourceLocalVariableDeclaration locals)

Creates a field declaration to match the local variable declaration. Note, this function does not convert the local variable declaration or any fo the variables therein. Instead, this function creates a field variable for each local variable and then creates a field declaration out of those field variables. The input local variable declaration should be discarded after this.

Parameters:

locals - Require non-null.

createSuperclassClause

public abstract SourceSuperclassClause createSuperclassClause(SourceTypeReference superclass)

Creates a superclass ("extends" on a class) clause.

Parameters:

superclass - Null means an empty superclass clause.

Returns:

Null if empty.

createInterfacesClause

public final SourceInterfacesClause createInterfacesClause(SourceTypeReference one)

Creates an interfaces ("implements" on a class and "extends" on an interface) clause.

Parameters:

one - Null indicates an empty interfaces clause.

Returns:

Null if empty.

createInterfacesClause

public abstract SourceInterfacesClause createInterfacesClause(SourceTypeReference[] types)

Creates an interfaces ("implements" on a class and "extends" on an interface) clause.

Parameters:

interfaces - Null indicates an empty interfaces clause.

Returns:

Null if empty.

createClassBody

public final SourceClassBody createClassBody()

Creates an empty class body.

createClassBody

public final SourceClassBody createClassBody(SourceMember member)

Creates an empty class body.

createClassBody

public abstract SourceClassBody createClassBody(SourceMember[] members)

Creates a class body.

Parameters:

members - Require non-null. For an empty class body, use SourceMember.EMPTY_ARRAY.

createFormalParameter

public abstract SourceFormalParameter createFormalParameter(SourceLocalVariable variable)

Creates a formal parameter using a local variable as a template. After this call, the input variable object is no longer valid.

Parameters:

variable - A newly created local variable from this factory.

createCatchParameter

public abstract SourceCatchParameter createCatchParameter(java.util.List types,
                                                          java.lang.String name)

Creates a catch clause parameter from a union of types

Parameters:

types - A union of types, which should be a List of SourceTypeReferences

name - The name of the parameter

Returns:

The resulting catch clause parameter

createFormalParameterList

public final SourceFormalParameterList createFormalParameterList()

Creates an empty formal parameter list.

createFormalParameterList

public final SourceFormalParameterList createFormalParameterList(SourceLocalVariable variable)

Input parameters, if any, will be converted to be formal parameters, namely SRC_FORMAL_PARAMETER.

Parameters:

parameter - Require non-null.

createFormalParameterList

public final SourceFormalParameterList createFormalParameterList(SourceLocalVariable[] variables)

Input parameters, if any, will be converted to be formal parameters, namely SRC_FORMAL_PARAMETER.

Parameters:

parameters - Require non-null. For an empty parameter list, use SourceLocalVariable.EMPTY_ARRAY.

createFormalParameterList

public final SourceFormalParameterList createFormalParameterList(SourceFormalParameter parameter)

Input parameters, if any, will be converted to be formal parameters, namely SRC_FORMAL_PARAMETER.

Parameters:

parameter - Require non-null.

createFormalParameterList

public abstract SourceFormalParameterList createFormalParameterList(SourceFormalParameter[] parameters)

Input parameters, if any, will be converted to be formal parameters, namely SRC_FORMAL_PARAMETER.

Parameters:

parameters - Require non-null. For an empty parameter list, use SourceLocalVariable.EMPTY_ARRAY.

createThrowsClause

public final SourceThrowsClause createThrowsClause(SourceTypeReference exception)

Parameters:

exception - Require non-null.

createThrowsClause

public abstract SourceThrowsClause createThrowsClause(SourceTypeReference[] exceptions)

Parameters:

exceptions - Require non-null. For an empty exception array use SourceTypeReference.EMPTY_ARRAY.

Returns:

Null if empty.

createFieldVariable

public final SourceFieldVariable createFieldVariable(SourceTypeReference type,
                                                     java.lang.String name)

Creates a field variable.

Parameters:

type - Require non-null.

name - Must be a valid simple name.

Throws:

java.lang.IllegalArgumentException - if name is not a valid simple name.

createFieldVariable

public final SourceFieldVariable createFieldVariable(int modifiers,
                                                     SourceTypeReference type,
                                                     java.lang.String name)

Creates a field variable.

Parameters:

type - Require non-null.

name - Must be a valid simple name.

Throws:

java.lang.IllegalArgumentException - if name is not a valid simple name.

createFieldVariable

public final SourceFieldVariable createFieldVariable(SourceTypeReference type,
                                                     java.lang.String name,
                                                     SourceExpression initializer)

Creates a field variable

Parameters:

type - Require non-null.

name - Must be a valid simple name.

initializer - Null indicates none.

Throws:

java.lang.IllegalArgumentException - if name is not a valid simple name.

createFieldVariable

public final SourceFieldVariable createFieldVariable(int modifiers,
                                                     SourceTypeReference type,
                                                     java.lang.String name,
                                                     SourceExpression initializer)

Creates a field variable.

Parameters:

type - Require non-null.

name - Must be a valid simple name.

initializer - Null indicates none.

Throws:

java.lang.IllegalArgumentException - if name is not a valid simple name.

createFieldVariable

public final SourceFieldVariable createFieldVariable(int modifiers,
                                                     SourceTypeReference type,
                                                     java.lang.String name,
                                                     int xdimensions,
                                                     SourceExpression initializer)

Creates a field variable.

Parameters:

type - Require non-null.

name - Must be a valid simple name.

xdimensions - The number of extra array dimensions to modify the field variable with.

initializer - Null indicates none.

Throws:

java.lang.IllegalArgumentException - if name is not a valid simple name.

createFieldDeclaration

public final SourceFieldDeclaration createFieldDeclaration(SourceTypeReference type,
                                                           java.lang.String name)

Creates a field declaration.

See Also:

createFieldVariable( SourceTypeReference, String )

createFieldDeclaration

public final SourceFieldDeclaration createFieldDeclaration(int modifiers,
                                                           SourceTypeReference type,
                                                           java.lang.String name)

Creates a field declaration.

See Also:

createFieldVariable( int, SourceTypeReference, String )

createFieldDeclaration

public final SourceFieldDeclaration createFieldDeclaration(SourceTypeReference type,
                                                           java.lang.String name,
                                                           SourceExpression initializer)

Creates a field declaration.

See Also:

createFieldVariable( SourceTypeReference, String, SourceExpression )

createFieldDeclaration

public final SourceFieldDeclaration createFieldDeclaration(int modifiers,
                                                           SourceTypeReference type,
                                                           java.lang.String name,
                                                           SourceExpression initializer)

Creates a field declaration.

See Also:

createFieldVariable( int, SourceTypeReference, String, SourceExpression )

createLocalVariable

public final SourceLocalVariable createLocalVariable(SourceTypeReference type,
                                                     java.lang.String name)

Creates a local variable.

Parameters:

type - Require non-null.

name - Must be a valid simple name.

Throws:

java.lang.IllegalArgumentException - if name is not a valid simple name.

createLocalVariable

public final SourceLocalVariable createLocalVariable(int modifiers,
                                                     SourceTypeReference type,
                                                     java.lang.String name)

Creates a local variable.

Parameters:

modifiers - Valid values are ACC_none and ACC_FINAL.

type - Require non-null.

name - Must be a valid simple name.

Throws:

java.lang.IllegalArgumentException - if name is not a valid simple name.

createLocalVariable

public final SourceLocalVariable createLocalVariable(SourceTypeReference type,
                                                     java.lang.String name,
                                                     SourceExpression initializer)

Creates a local variable

Parameters:

type - Require non-null.

name - Must be a valid simple name.

initializer - Null indicates none.

Throws:

java.lang.IllegalArgumentException - if name is not a valid simple name.

createLocalVariable

public final SourceLocalVariable createLocalVariable(int modifiers,
                                                     SourceTypeReference type,
                                                     java.lang.String name,
                                                     SourceExpression initializer)

Creates a local variable.

Parameters:

modifiers - Valid values are ACC_none and ACC_FINAL.

type - Require non-null.

name - Must be a valid simple name.

initializer - Null indicates none.

Throws:

java.lang.IllegalArgumentException - if name is not a valid simple name.

createLocalVariable

public abstract SourceLocalVariable createLocalVariable(int modifiers,
                                                        SourceTypeReference type,
                                                        java.lang.String name,
                                                        int xdimensions,
                                                        SourceExpression initializer)

Creates a local variable.

Parameters:

modifiers - Valid values are ACC_none and ACC_FINAL.

type - Require non-null.

name - Must be a valid simple name.

xdimensions - The number of extra array dimensions to modify the local variable with.

initializer - Null indicates none.

Throws:

java.lang.IllegalArgumentException - if name is not a valid simple name.

createLocalVariableDeclaration

public final SourceLocalVariableDeclaration createLocalVariableDeclaration(SourceTypeReference type,
                                                                           java.lang.String name)

Creates a local variable declaration.

See Also:

createLocalVariable( SourceTypeReference, String )

createLocalVariableDeclaration

public final SourceLocalVariableDeclaration createLocalVariableDeclaration(int modifiers,
                                                                           SourceTypeReference type,
                                                                           java.lang.String name)

Creates a local variable declaration.

See Also:

createLocalVariable( int, SourceTypeReference, String )

createLocalVariableDeclaration

public final SourceLocalVariableDeclaration createLocalVariableDeclaration(SourceTypeReference type,
                                                                           java.lang.String name,
                                                                           SourceExpression initializer)

Creates a local variable declaration.

See Also:

createLocalVariable( SourceTypeReference, String, SourceExpression )

createLocalVariableDeclaration

public final SourceLocalVariableDeclaration createLocalVariableDeclaration(int modifiers,
                                                                           SourceTypeReference type,
                                                                           java.lang.String name,
                                                                           SourceExpression initializer)

Creates a local variable declaration.

See Also:

createLocalVariable( int, SourceTypeReference, String, SourceExpression )

createLocalVariableDeclaration

public abstract SourceLocalVariableDeclaration createLocalVariableDeclaration(SourceLocalVariable variable)

Creates a local variable declaration.

Parameters:

variable - Require non-null.

createLocalVariableDeclaration

@Deprecated
public final SourceLocalVariableDeclaration createLocalVariableDeclaration(SourceLocalVariable[] variables)

Deprecated. Not implemented yet. Creates a local variable declaration.

createBlock

public final SourceBlock createBlock()

Creates an empty code block.

createBlock

public abstract SourceBlock createBlock(SourceElement[] elements)

Creates a code block.

Parameters:

elements - The elements for the code block.

createAssertStatement

public abstract SourceAssertStatement createAssertStatement(SourceExpression condition,
                                                            SourceExpression output)

Creates an assert statement.

Parameters:

condition - Require non-null.

output - Require non-null.

createBlockStatement

public abstract SourceBlockStatement createBlockStatement(SourceBlock block)

Creates a block statement.

Parameters:

block - Null indicates an empty block.

createBreakStatement

public abstract SourceBreakStatement createBreakStatement(java.lang.String target)

Creates a break statement.

Parameters:

target - Null indicates the implicitly enclosing loop.

createCatchClause

@Deprecated
public final SourceCatchClause createCatchClause(SourceLocalVariable parameter,
                                                            SourceBlockStatement block)

Deprecated. This method can only create JDK6 ( or before ) compatible catch parameters. Use createCatchClause( SourceCatchParameter, SourceBlockStatement ) instead

Creates a catch clause for a try-catch or a try-catch-finally statement. The input parameter will be converted to be a SRC_CATCH_PARAMETER.

Parameters:

parameter - Require non-null.

block - Null indicates an empty clause.

Returns:

The catch clause

createCatchClause

@Deprecated
public abstract SourceCatchClause createCatchClause(SourceFormalParameterList parameters,
                                                               SourceBlockStatement block)

Deprecated. Use createCatchClause( SourceCatchParameter, SourceBlockStatement ) instead

Creates a catch clause for a try-catch or a try-catch-finally statement.

Parameters:

parameters - Require non-null. Must have exactly one parameter in the list.

block - Null indicates an empty clause.

Returns:

The catch clause

createCatchClause

public abstract SourceCatchClause createCatchClause(SourceCatchParameter parameter,
                                                    SourceBlockStatement block)

Creates a catch clause for a try-catch or a try-catch-finally statement.

Parameters:

parameter - Require non-null.

block - Null indicates an empty clause.

Returns:

The catch clause

createContinueStatement

public abstract SourceContinueStatement createContinueStatement(java.lang.String target)

Creates a continue statement.

Parameters:

target - Null indicates the implicitly enclosing loop.

createDoStatement

public abstract SourceDoStatement createDoStatement(SourceExpression e,
                                                    SourceStatement child)

Creates a do-while statement.

Parameters:

e - Require non-null

child - Null indicates an empty clause.

createElseClause

public abstract SourceElseClause createElseClause(SourceStatement child)

Creates an else clause for an if statement.

Parameters:

child - Null indicates an empty clause.

createEmptyStatement

public abstract SourceEmptyStatement createEmptyStatement()

Creates an empty statement.

createExpressionStatement

public abstract SourceExpressionStatement createExpressionStatement(SourceExpression e)

Creates an expression statement.

Parameters:

e - Require non-null.

createFinallyClause

public abstract SourceFinallyClause createFinallyClause(SourceBlockStatement child)

Creates a finally clause for a try statement.

Parameters:

child - Null indicates an empty clause.

createForStatement

public final SourceForStatement createForStatement(SourceExpression initialization,
                                                   SourceExpression condition,
                                                   SourceExpression update,
                                                   SourceStatement child)

Convenience method. Creates a traditional for loop with no variable declarators and with at most one initialization and at most one update.

Parameters:

initialization - Null means no initializations.

condition - Null means an implicitly true condition.

update - Null means no updates.

child - Null indicates an empty clause.

createForStatement

public abstract SourceForStatement createForStatement(SourceListExpression initializations,
                                                      SourceExpression condition,
                                                      SourceListExpression updates,
                                                      SourceStatement child)

Creates a traditional for loop with no variable declarators.

Parameters:

initializations - Null means no initializations.

condition - Null means an implicitly true condition.

updates - Null means no updates.

child - Null indicates an empty clause.

createForVariableStatement

public final SourceForStatement createForVariableStatement(SourceLocalVariable variable,
                                                           SourceExpression condition,
                                                           SourceExpression update,
                                                           SourceStatement child)

Convenience method. Creates a traditional for loop with a single local variable and at most one update expression.

Parameters:

variable - Require non-null.

condition - Null means an implicitly true condition.

update - Null means no update.

child - Null indicates an empty clause.

createForVariableStatement

public abstract SourceForStatement createForVariableStatement(SourceLocalVariableDeclaration variables,
                                                              SourceExpression condition,
                                                              SourceListExpression updates,
                                                              SourceStatement child)

Creates a traditional for loop with variable declarations.

Parameters:

variables - Require non-null.

condition - Null means an implicitly true condition.

updates - Null means no updates.

child - Null indicates an empty clause.

createForEnhancedStatement

public final SourceForStatement createForEnhancedStatement(SourceLocalVariable loopVariable,
                                                           SourceExpression collection,
                                                           SourceStatement child)

Creates an enhanced-for loop.

Parameters:

loopVariable - Require non-null.

collection - Require non-null.

child - Null indicates an empty clause.

createForEnhancedStatement

public abstract SourceForStatement createForEnhancedStatement(SourceLocalVariableDeclaration loopVarDecl,
                                                              SourceExpression collection,
                                                              SourceStatement child)

Creates an enhanced-for loop.

Parameters:

loopVariable - Require non-null.

collection - Require non-null.

child - Null indicates an empty clause.

createIfStatement

public abstract SourceIfStatement createIfStatement(SourceExpression e,
                                                    SourceStatement child)

Creates an if statement. Will not create the else clause.

Parameters:

e - Require non-null.

child - Null indicates an empty clause.

createIfStatement

public abstract SourceIfStatement createIfStatement(SourceExpression e,
                                                    SourceStatement child,
                                                    SourceElseClause clause)

Creates an if or an if-else statement. Will not create the else clause if none is given.

Parameters:

e - Require non-null

child - Null indicates an empty true clause.

clause - Null means no else clause.

createIfElseStatement

public final SourceIfStatement createIfElseStatement(SourceExpression e,
                                                     SourceStatement trueClause,
                                                     SourceStatement elseClause)

Creates an if-else statement. Always creates the else clause, even if empty.

Parameters:

e - Require non-null.

trueClause - Null indicates an empty true clause.

elseClause - Null indicates an empty else clause.

createReturnStatement

public abstract SourceReturnStatement createReturnStatement(SourceExpression e)

Creates a return statement.

Parameters:

e - Null indicates a void return.

createSwitchStatement

public abstract SourceSwitchStatement createSwitchStatement(SourceExpression e,
                                                            SourceBlockStatement child)

Creates a switch statement.

Parameters:

e - Require non-null.

child - Null indicates an empty block.

createSynchronizedStatement

public abstract SourceSynchStatement createSynchronizedStatement(SourceExpression e,
                                                                 SourceBlockStatement child)

Creates a synchronized statement.

Parameters:

e - Require non-null.

child - Null indicates an empty block.

createThrowStatement

public abstract SourceThrowStatement createThrowStatement(SourceExpression e)

Creates a throw statement.

Parameters:

e - Require non-null.

createTryStatement

public abstract SourceTryStatement createTryStatement(SourceBlockStatement tryClause,
                                                      SourceCatchClause[] catchClauses,
                                                      SourceFinallyClause finallyClause)

Creates a try, try-catch, try-catch-finally, or a try-finally statement.

Parameters:

tryClause - Null indicates an empty try clause.

catchClauses - Require non-null. If you want no catch clauses, use SourceCatchClause.EMPTY_ARRAY.

finallyClause - Null indicates no finally clause.

createTryCatchStatement

@Deprecated
public final SourceTryStatement createTryCatchStatement(SourceBlockStatement tryClause,
                                                                   SourceLocalVariable parameter,
                                                                   SourceBlockStatement catchClause)

Deprecated. Use createTryCatchStatement( SourceBlockStatement, SourceCatchParameter, SourceBlockStatement ) instead

Creates a try-catch statement with a single catch clause.

Parameters:

tryClause - Null indicates an empty try clause.

parameter - Require non-null.

catchClause - Null indicates an empty catch clause.

createTryCatchStatement

@Deprecated
public final SourceTryStatement createTryCatchStatement(SourceBlockStatement tryClause,
                                                                   SourceFormalParameter parameter,
                                                                   SourceBlockStatement catchClause)

Deprecated. Use createTryCatchStatement( SourceBlockStatement, SourceCatchParameter, SourceBlockStatement ) instead

Creates a try-catch statement with a single catch clause.

Parameters:

tryClause - Null indicates an empty try clause.

parameter - Require non-null.

catchClause - Null indicates an empty catch clause.

createTryCatchStatement

@Deprecated
public abstract SourceTryStatement createTryCatchStatement(SourceBlockStatement tryClause,
                                                                      SourceFormalParameterList parameters,
                                                                      SourceBlockStatement catchClause)

Deprecated. Use createTryCatchStatement( SourceBlockStatement, SourceCatchParameter, SourceBlockStatement ) instead

Creates a try-catch statement with a single catch clause.

Parameters:

tryClause - Null indicates an empty try clause.

parameters - Require non-null.

catchClause - Null indicates an empty catch clause.

createTryCatchStatement

public abstract SourceTryStatement createTryCatchStatement(SourceBlockStatement tryClause,
                                                           SourceCatchParameter parameter,
                                                           SourceBlockStatement catchClause)

Creates a try-catch statement with a single catch clause.

Parameters:

tryClause - Null indicates an empty try clause.

parameter - Require non-null.

catchClause - Null indicates an empty catch clause.

createTryCatchFinallyStatement

@Deprecated
public final SourceTryStatement createTryCatchFinallyStatement(SourceBlockStatement tryClause,
                                                                          SourceLocalVariable parameter,
                                                                          SourceBlockStatement catchClause,
                                                                          SourceBlockStatement finallyClause)

Deprecated. Use createTryCatchFinallyStatement( SourceBlockStatement, SourceCatchParameter, SourceBlockStatement, SourceBlockStatement instead

Creates a try-catch-finally statement with a single catch clause. Always creates the finally clause.

Parameters:

tryClause - Null indicates an empty try clause.

parameter - Require non-null.

catchClause - Null indicates an empty catch clause.

finallyClause - Null indicates an empty finally clause.

createTryCatchFinallyStatement

@Deprecated
public final SourceTryStatement createTryCatchFinallyStatement(SourceBlockStatement tryClause,
                                                                          SourceFormalParameter parameter,
                                                                          SourceBlockStatement catchClause,
                                                                          SourceBlockStatement finallyClause)

Deprecated. Use createTryCatchFinallyStatement( SourceBlockStatement, SourceCatchParameter, SourceBlockStatement, SourceBlockStatement instead

Creates a try-catch-finally statement with a single catch clause. Always creates the finally clause.

Parameters:

tryClause - Null indicates an empty try clause.

parameter - Require non-null.

catchClause - Null indicates an empty catch clause.

finallyClause - Null indicates an empty finally clause.

createTryCatchFinallyStatement

@Deprecated
public abstract SourceTryStatement createTryCatchFinallyStatement(SourceBlockStatement tryClause,
                                                                             SourceFormalParameterList parameters,
                                                                             SourceBlockStatement catchClause,
                                                                             SourceBlockStatement finallyClause)

Deprecated. Use createTryCatchFinallyStatement( SourceBlockStatement, SourceCatchParameter, SourceBlockStatement, SourceBlockStatement instead

Creates a try-catch-finally statement with a single catch clause. Always creates the finally clause.

Parameters:

tryClause - Null indicates an empty try clause.

parameters - Require non-null.

catchClause - Null indicates an empty catch clause.

finallyClause - Null indicates an empty finally clause.

createTryCatchFinallyStatement

public abstract SourceTryStatement createTryCatchFinallyStatement(SourceBlockStatement tryClause,
                                                                  SourceCatchParameter parameter,
                                                                  SourceBlockStatement catchClause,
                                                                  SourceBlockStatement finallyClause)

Creates a try-catch-finally statement with a single catch clause. Always creates the finally clause.

Parameters:

tryClause - Null indicates an empty try clause.

parameter - Require non-null.

catchClause - Null indicates an empty catch clause.

finallyClause - Null indicates an empty finally clause.

createTryFinallyStatement

public abstract SourceTryStatement createTryFinallyStatement(SourceBlockStatement child,
                                                             SourceBlockStatement finallyClause)

Creates a try-finally statement. Always creates the finally clause.

Parameters:

child - Null indicates an empty try clause.

finallyClause - Null indicates an empty finally clause.

createWhileStatement

public abstract SourceWhileStatement createWhileStatement(SourceExpression e,
                                                          SourceStatement child)

Creates a while statement.

Parameters:

e - Require non-null.

child - Null indicates an empty clause.

createStatementLabel

public abstract SourceStatementLabel createStatementLabel(java.lang.String name)

createSwitchCaseLabel

public abstract SourceSwitchLabel createSwitchCaseLabel(SourceExpression e)

createSwitchDefaultLabel

public abstract SourceSwitchLabel createSwitchDefaultLabel()

createAnnotationExpression

public abstract SourceAnnotationExpression createAnnotationExpression(SourceAnnotation a)

Creates an argument list with one argument.

Parameters:

arg - Require non-null.

createArgumentList

public final SourceListExpression createArgumentList()

Creates an argument list with one argument.

Parameters:

arg - Require non-null.

createArgumentList

public final SourceListExpression createArgumentList(SourceExpression arg)

Creates an argument list with one argument.

Parameters:

arg - Require non-null.

createArgumentList

public final SourceListExpression createArgumentList(SourceExpression[] arguments)

Creates an argument list.

Parameters:

arguments - Null indicates an empty list.

createArrayAccess

public abstract SourceArrayAccessExpression createArrayAccess(SourceExpression lhs,
                                                              SourceListExpression dereferences)

Creates an array access.

Parameters:

lhs - Require non-null.

dereferences - Requires non-null. Use createArgumentList([).

createArrayConstant

public abstract SourceListExpression createArrayConstant(SourceExpression[] operands)

Creates an array constant.

Parameters:

operands - The operands which cannot be null, and none of the SourceExpressions in the array can be null

Throws:

java.lang.NullPointerException - if operands is null or any of the SourceExpressions in the operands array are null

createAssignment

public abstract SourceAssignmentExpression createAssignment(int code,
                                                            SourceExpression lhs,
                                                            SourceExpression rhs)

Creates an assignment expression.

Parameters:

code - The simple assignment is JavaOperators.OPT_ASG. For a complete list of valid values, check the JavaConstants.opt2srcTable array for SRC_EXPR_ASSIGNMENT.

createClassCreator

@Deprecated
public final SourceNewClassExpression createClassCreator(SourceExpression lhs,
                                                                    SourceTypeReference type,
                                                                    SourceListExpression arguments,
                                                                    SourceClassBody body)

Deprecated. Use createNewClassExpression(SSSS).

createDotReference

public abstract SourceDotExpression createDotReference(SourceExpression lhs,
                                                       java.lang.String name)

Creates a dot reference. Dot references have the form: lhs.name

Parameters:

lhs - Require non-null.

name - Must be a valid simple name.

Throws:

java.lang.IllegalArgumentException - if name is not a valid simple name.

createExpressionList

public final SourceListExpression createExpressionList()

createExpressionList

public final SourceListExpression createExpressionList(SourceExpression argument)

Creates a list expression with one element. May not be used in place of an array constant.

Parameters:

argument - Null indicates an empty list.

createExpressionList

public abstract SourceListExpression createExpressionList(SourceExpression[] arguments)

Creates a list expression. May not be used in place of an array constant.

Parameters:

arguments - Null indicates an empty list.

createInfixExpression

public abstract SourceInfixExpression createInfixExpression(int code,
                                                            SourceExpression lhs,
                                                            SourceExpression rhs)

Creates an infix expression with two operands.

Parameters:

code - For valid values, check the JavaConstants.opt2srcTable array for SRC_EXPR_INFIX.

createInfixExpression

public abstract SourceInfixExpression createInfixExpression(int code,
                                                            SourceExpression[] operands)

Creates an infix expression with multiple operands. An example is: "Hello" + ' ' + "world!"

Parameters:

code - For valid values, check the JavaConstants.opt2srcTable array for SRC_EXPR_INFIX.

operands - Must have at least two operands.

createInstanceof

public final SourceInfixExpression createInstanceof(SourceExpression lhs,
                                                    SourceTypeReference type)

Creates a new instanceof expression.

Parameters:

lhs - Require non-null.

type - Require a reference type.

createMethodCall

public final SourceMethodCallExpression createMethodCall(SourceExpression lhs,
                                                         java.lang.String name,
                                                         SourceListExpression arguments)

Creates a method call.

Parameters:

lhs - Null indicates the implicit "this" lhs.

name - Must be a valid simple name.

arguments - Null indicates no arguments. Use createArgumentList([).

Throws:

java.lang.IllegalArgumentException - if name is not a valid simple name.

createMethodCall

public abstract SourceMethodCallExpression createMethodCall(SourceExpression lhs,
                                                            SourceTypeArgument[] typeArguments,
                                                            java.lang.String name,
                                                            SourceListExpression arguments)

Creates a method call.

Parameters:

lhs - Null indicates the implicit "this" lhs.

name - Must be a valid simple name.

arguments - Null indicates no arguments. Use createArgumentList([).

Throws:

java.lang.IllegalArgumentException - if name is not a valid simple name.

createNewInitializedArrayExpression

public final SourceNewArrayExpression createNewInitializedArrayExpression(SourceTypeReference type,
                                                                          SourceListExpression arrayconst)

Creates an array creator.

Parameters:

type - Require non-null.

arrayconst - Must be an array constant (e.g. created via the createArrayConstant() method).

createNewUninitializedArrayExpression

public final SourceNewArrayExpression createNewUninitializedArrayExpression(SourceTypeReference type,
                                                                            SourceListExpression args)

Creates an array creator.

Parameters:

type - Require non-null.

createNewArrayExpressionImpl

protected abstract SourceNewArrayExpression createNewArrayExpressionImpl(SourceTypeReference type,
                                                                         SourceListExpression list)

(Internal) Creates an array creator.

createNewClassExpression

public abstract SourceNewClassExpression createNewClassExpression(SourceExpression lhs,
                                                                  SourceTypeReference type,
                                                                  SourceListExpression arguments,
                                                                  SourceClassBody body)

Creates a class creator. Class creators have the form: new type( arg ) new type( arg ) { void bodyMethods(); } lhs.new type( arg ) lhs.new type( arg ) { void bodyMethods(); }

Parameters:

lhs - Non-null indicates a qualified class creator (for creating non-static inner classes).

type - Require non-null. Require non-array reference type.

arguments - Null indicates no arguments. Use createArgumentList([).

body - Non-null indicates an anonymous class.

createQuestionExpression

public abstract SourceQuestionExpression createQuestionExpression(SourceExpression one,
                                                                  SourceExpression two,
                                                                  SourceExpression three)

Creates a question expression.

Parameters:

one - The conditional operand. Require non-null.

two - The operand executed by the true branch. Require non-null.

three - The operand executed by the false branch. Require non-null.

createSimpleNameExpression

public abstract SourceSimpleNameExpression createSimpleNameExpression(java.lang.String name)

Creates a simple name expression.

Parameters:

name - Must be a valid simple name.

Throws:

java.lang.IllegalArgumentException - if name is not a valid simple name.

createTypeExpression

public final SourceTypeExpression createTypeExpression(java.lang.String type)

Creates a type expression.

Parameters:

type - Require non-null.

createTypeExpression

public abstract SourceTypeExpression createTypeExpression(SourceTypeReference type)

Creates a type expression.

Parameters:

type - Require non-null.

createTypecast

public abstract SourceTypecastExpression createTypecast(SourceTypeReference type,
                                                        SourceExpression operand)

Creates a typecast.

Parameters:

type - Require non-null. Require a reference type.

operand - Require non-null.

createUnaryExpression

public abstract SourceUnaryExpression createUnaryExpression(int code,
                                                            SourceExpression operand)

Creates a unary expression.

Parameters:

code - For valid values, check the JavaConstants.opt2srcTable array for SRC_EXPR_UNARY.

operand - Require non-null.

createWrapperExpression

public abstract SourceWrapperExpression createWrapperExpression(SourceExpression operand)

Creates a wrapper expression.

Parameters:

operand - Require non-null.

createDocTextFragment

public abstract SourceDocTextFragment createDocTextFragment(java.lang.String text)

Creates a doc text fragment.

If you want a full line of doc text, text should end with the '\n' character. Text may not contain more than one '\n' character. Newlines may optionally also be expressed as "\r" or "\r\n", both will be converted to being "\n". To get multiple lines of doc text, you must create multiple doc text fragments.

Parameters:

text - Require non-null. Require non-empty.

createDocTagName

public final SourceDocTagName createDocTagName(short tag)

Creates a doc tag name from the token value.

Parameters:

tag - Require [TAG_base, TAG_max).

createDocTagName

public abstract SourceDocTagName createDocTagName(java.lang.String name)

Creates a doc tag name.

Parameters:

name - Require non-null. Require name.startsWith( "@" ).

createDocComment

public final SourceDocComment createDocComment()

Creates a doc comment, empty.

createDocComment

public final SourceDocComment createDocComment(SourceDocDescription description)

Creates a doc comment with the given description.

Parameters:

description - May be null.

createDocComment

public final SourceDocComment createDocComment(SourceDocDescription description,
                                               SourceDocBlockTag tag)

Creates a doc comment with the given description and block tags.

Parameters:

description - May be null.

tags - Null indicates no block tags.

createDocComment

public abstract SourceDocComment createDocComment(SourceDocDescription description,
                                                  SourceDocBlockTag[] tags)

Creates a doc comment with the given description and block tags.

Parameters:

description - May be null.

tags - Null indicates no block tags.

createDocDescription

public final SourceDocDescription createDocDescription()

Creates a doc description, empty.

createDocDescription

public final SourceDocDescription createDocDescription(SourceDocTextFragment line)

Creates a doc description with a single line of text.

Parameters:

line - Require non-null. The line may optionally end with a newline.

createDocDescription

public abstract SourceDocDescription createDocDescription(SourceDocTextFragment[] lines)

Creates a doc description from the input lines of text.

Parameters:

lines - If non-null, all but the last of the text lines must end with a newline. The last one may optionally end with a newline.

createDocClassReference

public final SourceDocReference createDocClassReference(java.lang.String qualifiedName)

Creates a doc reference with the class reference syntax.

Parameters:

qualifiedName - Require non-null. May be a simple or qualified class name in dotted notation, e.g. "String", "java.util.Map".

createDocMemberReference

public final SourceDocReference createDocMemberReference(java.lang.String classString,
                                                         java.lang.String memberName)

Creates a doc reference with the member reference syntax.

Parameters:

classString - May be null. Dotted notation.

memberName - The simple name identifying the member.

createDocMethodReference

public final SourceDocReference createDocMethodReference(java.lang.String classString,
                                                         java.lang.String methodName,
                                                         java.lang.String[] parameterTypes)

Creates a doc reference with the method reference syntax. Used for methods and constructors.

Parameters:

classString - May be null. Dotted notation.

methodName - Require no-null. The simple method name.

parameterTypes - Require non-null. An array of names representing the parameter types. Should be in dotted notation, e.g. "String", "int[]".

createDocParameterReference

public abstract SourceDocReference createDocParameterReference(java.lang.String parameterName)

Creates a doc reference with the parameter syntax. Used for parameters.

Parameters:

parameterName - Require non-null.

createDocReference

public abstract SourceDocReference createDocReference(java.lang.String classString,
                                                      java.lang.String memberName,
                                                      java.lang.String[] parameterTypes)

Creates a doc reference.

createDocBlockTag

public final SourceDocBlockTag createDocBlockTag(SourceDocTagName name)

Creates a doc block tag.

Parameters:

name - Require non-null.

createDocBlockTag

public final SourceDocBlockTag createDocBlockTag(SourceDocTagName name,
                                                 SourceDocDescription description)

Creates a doc block tag with no references.

Parameters:

name - Require non-null.

description - May be null.

createDocBlockTag

public final SourceDocBlockTag createDocBlockTag(SourceDocTagName name,
                                                 SourceDocReference reference,
                                                 SourceDocDescription description)

Creates a doc block tag with one reference. In code, a reference precedes a description.

Parameters:

name - Require non-null.

reference - Require non-null.

description - May be null.

createDocBlockTag

public abstract SourceDocBlockTag createDocBlockTag(SourceDocTagName name,
                                                    SourceDocReference[] references,
                                                    SourceDocDescription description)

Creates a doc block tag with many references. In code, a reference precedes a description.

Parameters:

name - Require non-null.

references - Require non-null.

description - May be null.

createDocInlineTag

public final SourceDocInlineTag createDocInlineTag(SourceDocTagName name)

Creates a doc inline tag.

Parameters:

name - Require non-null.

createDocInlineTag

public final SourceDocInlineTag createDocInlineTag(SourceDocTagName name,
                                                   SourceDocDescription description)

Creates a doc inline tag with no references.

Parameters:

name - Require non-null.

description - May be null.

createDocInlineTag

public final SourceDocInlineTag createDocInlineTag(SourceDocTagName name,
                                                   SourceDocReference reference,
                                                   SourceDocDescription description)

Creates a doc inline tag with one reference. In code, a reference precedes a description.

Parameters:

name - Require non-null.

reference - Require non-null.

description - May be null.

createDocInlineTag

public abstract SourceDocInlineTag createDocInlineTag(SourceDocTagName name,
                                                      SourceDocReference[] references,
                                                      SourceDocDescription description)

Creates a doc inline tag with many references. In code, a reference precedes a description.

Parameters:

name - Require non-null.

references - Require non-null.

description - May be null.