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
- All Implemented Interfaces:
org.eclipse.core.resources.IWorkspaceRunnable
,org.eclipse.core.runtime.ICoreRunnable
,org.eclipse.core.runtime.IProgressMonitor
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
Modifier and TypeFieldDescriptionprotected String
The name of the package declaration being createdFields 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
Fields inherited from interface org.eclipse.core.runtime.IProgressMonitor
UNKNOWN
-
Constructor Summary
ConstructorDescriptionCreatePackageDeclarationOperation(String name, ICompilationUnit parentElement)
When executed, this operation will add a package declaration to the given compilation unit. -
Method Summary
Modifier and TypeMethodDescriptionprotected ASTNode
generateElementAST(ASTRewrite rewriter, ICompilationUnit cu)
protected IJavaElement
Creates and returns the handle for the element this operation created.protected StructuralPropertyDescriptor
getChildPropertyDescriptor(ASTNode parent)
Returns the name of the main task of this operation for progress reporting.protected void
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 CUverify()
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, getLatestASTLevel, 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
Methods inherited from interface org.eclipse.core.runtime.IProgressMonitor
clearBlocked, setBlocked, slice
-
Field Details
-
name
The name of the package declaration being created
-
-
Constructor Details
-
CreatePackageDeclarationOperation
When executed, this operation will add a package declaration to the given compilation unit.
-
-
Method Details
-
getChildPropertyDescriptor
- Specified by:
getChildPropertyDescriptor
in classCreateElementInCUOperation
-
generateElementAST
protected ASTNode generateElementAST(ASTRewrite rewriter, ICompilationUnit cu) throws JavaModelException- Specified by:
generateElementAST
in classCreateElementInCUOperation
- Throws:
JavaModelException
-
generateResultHandle
Creates and returns the handle for the element this operation created.- Specified by:
generateResultHandle
in classCreateElementInCUOperation
-
getMainTaskName
Description copied from class:CreateElementInCUOperation
Returns the name of the main task of this operation for progress reporting.- Specified by:
getMainTaskName
in classCreateElementInCUOperation
- 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 classCreateElementInCUOperation
-
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 classCreateElementInCUOperation
- See Also:
IJavaModelStatus
,JavaConventions
-