org.aspectj.org.eclipse.jdt.internal.core
Class CreatePackageDeclarationOperation

java.lang.Object
  org.aspectj.org.eclipse.jdt.internal.core.JavaModelOperation
      org.aspectj.org.eclipse.jdt.internal.core.CreateElementInCUOperation
          org.aspectj.org.eclipse.jdt.internal.core.CreatePackageDeclarationOperation

public class CreatePackageDeclarationOperation
extends CreateElementInCUOperation

This operation adds/replaces a package declaration in an existing compilation unit. If the compilation unit already includes the specified package declaration, it is not generated (it does not generate duplicates).

Required Attributes:

• Compilation unit element
• Package name

Nested Class Summary

Nested classes/interfaces inherited from class org.aspectj.org.eclipse.jdt.internal.core.JavaModelOperation

JavaModelOperation.IPostAction

Field Summary

protected java.lang.String

name The name of the package declaration being created

Fields inherited from class org.aspectj.org.eclipse.jdt.internal.core.CreateElementInCUOperation

anchorElement, creationOccurred, cuAST, INSERT_AFTER, INSERT_BEFORE, INSERT_LAST, insertionPolicy

Fields inherited from class org.aspectj.org.eclipse.jdt.internal.core.JavaModelOperation

actions, actionsEnd, actionsStart, APPEND, attributes, elementsToProcess, force, HAS_MODIFIED_RESOURCE_ATTR, isNested, KEEP_EXISTING, NO_ELEMENTS, OPERATION_STACKS, parentElements, POST_ACTION_VERBOSE, progressMonitor, REMOVEALL_APPEND, resultElements, TRUE

Constructor Summary

CreatePackageDeclarationOperation(java.lang.String name, ICompilationUnit parentElement)
When executed, this operation will add a package declaration to the given compilation unit.

Method Summary

protected ASTNode	generateElementAST(ASTRewrite rewriter, ICompilationUnit cu)
protected IJavaElement	generateResultHandle() Creates and returns the handle for the element this operation created.
protected StructuralPropertyDescriptor	getChildPropertyDescriptor(ASTNode parent)
java.lang.String	getMainTaskName() Returns the name of the main task of this operation for progress reporting.
protected void	initializeDefaultPosition() Sets the correct position for new package declaration: before the first import if no imports, before the first type if no type - first thing in the CU
IJavaModelStatus	verify() Possible failures: NO_ELEMENTS_TO_PROCESS - no compilation unit was supplied to the operation INVALID_NAME - a name supplied to the operation was not a valid package declaration name.

Methods inherited from class org.aspectj.org.eclipse.jdt.internal.core.CreateElementInCUOperation

checkCanceled, createAfter, createBefore, executeOperation, generateNewCompilationUnitAST, generateResultHandles, getCompilationUnit, getMainAmountOfWork, getSchedulingRule, insertASTNode, parse, setAlteredName, setRelativePosition

Methods inherited from class org.aspectj.org.eclipse.jdt.internal.core.JavaModelOperation

addAction, addDelta, addReconcileDelta, applyTextEdit, beginTask, canModifyRoots, commonVerify, copyResources, createFile, createFolder, deleteEmptyPackageFragment, deleteResource, deleteResources, done, equalsOneOf, executeNestedOperation, firstActionWithID, getAttribute, getCompilationUnitFor, getCurrentOperationStack, getDocument, getElementToProcess, getJavaModel, getNestedFolders, getParentElement, getParentElements, getResultElements, getSubProgressMonitor, hasModifiedResource, internalWorked, isCanceled, isReadOnly, isTopLevelOperation, moveResources, newJavaElementDelta, popOperation, postAction, prefixesOneOf, pushOperation, removeAllPostAction, removeReconcileDelta, run, runOperation, runPostActions, setAttribute, setCanceled, setNested, setTaskName, subTask, worked

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

The name of the package declaration being created

Constructor Detail

CreatePackageDeclarationOperation

public CreatePackageDeclarationOperation(java.lang.String name,
                                         ICompilationUnit parentElement)

When executed, this operation will add a package declaration to the given compilation unit.

Method Detail

getChildPropertyDescriptor

protected StructuralPropertyDescriptor getChildPropertyDescriptor(ASTNode parent)

Specified by:

getChildPropertyDescriptor in class CreateElementInCUOperation

generateElementAST

protected ASTNode generateElementAST(ASTRewrite rewriter,
                                     ICompilationUnit cu)
                              throws JavaModelException

Specified by:

generateElementAST in class CreateElementInCUOperation

Throws:

JavaModelException

generateResultHandle

protected IJavaElement generateResultHandle()

Creates and returns the handle for the element this operation created.

Specified by:

generateResultHandle in class CreateElementInCUOperation

getMainTaskName

public java.lang.String getMainTaskName()

Description copied from class: CreateElementInCUOperation

Returns the name of the main task of this operation for progress reporting.

Specified by:

getMainTaskName in class CreateElementInCUOperation

See Also:

CreateElementInCUOperation.getMainTaskName()

initializeDefaultPosition

protected void initializeDefaultPosition()

Sets the correct position for new package declaration:

• before the first import
• if no imports, before the first type
• if no type - first thing in the CU

• Overrides:

  initializeDefaultPosition in class CreateElementInCUOperation

verify

public IJavaModelStatus verify()

Possible failures:

• NO_ELEMENTS_TO_PROCESS - no compilation unit was supplied to the operation
• INVALID_NAME - a name supplied to the operation was not a valid package declaration name.

Overrides:

verify in class CreateElementInCUOperation

See Also:

IJavaModelStatus, JavaConventions