Klasse CreateElementInCUOperation
java.lang.Object
org.aspectj.org.eclipse.jdt.internal.core.JavaModelOperation
org.aspectj.org.eclipse.jdt.internal.core.CreateElementInCUOperation
- Alle implementierten Schnittstellen:
org.eclipse.core.resources.IWorkspaceRunnable,org.eclipse.core.runtime.ICoreRunnable,org.eclipse.core.runtime.IProgressMonitor
- Bekannte direkte Unterklassen:
CreateImportOperation,CreatePackageDeclarationOperation,CreateTypeMemberOperation
This abstract class implements behavior common to CreateElementInCUOperations.
To create a compilation unit, or an element contained in a compilation unit, the
source code for the entire compilation unit is updated and saved.
The element being created can be positioned relative to an existing
element in the compilation unit via the methods #createAfter
and #createBefore. By default, the new element is positioned
as the last child of its parent element.
-
Verschachtelte Klassen - Übersicht
Von Klasse geerbte verschachtelte Klassen/Schnittstellen org.aspectj.org.eclipse.jdt.internal.core.JavaModelOperation
JavaModelOperation.IPostAction -
Feldübersicht
FelderModifizierer und TypFeldBeschreibungprotected IJavaElementThe element that the newly created element is positioned relative to, as described byfInsertPosition, ornullif the newly created element will be positioned last.protected booleanA flag indicating whether creation of a new element occurred.protected CompilationUnitThe compilation unit AST used for this operationprotected static final intA constant meaning to position the new element after the element defined byfAnchorElement.protected static final intA constant meaning to position the new element before the element defined byfAnchorElement.protected static final intA constant meaning to position the new element as the last child of its parent element.protected intOne of the position constants, describing where to position the newly created element.Von Klasse geerbte Felder 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, TRUEVon Schnittstelle geerbte Felder org.eclipse.core.runtime.IProgressMonitor
UNKNOWN -
Konstruktorübersicht
KonstruktorenKonstruktorBeschreibungCreateElementInCUOperation(IJavaElement parentElement) Constructs an operation that creates a Java Language Element with the specified parent, contained within a compilation unit. -
Methodenübersicht
Modifizierer und TypMethodeBeschreibungprotected voidOnly allow cancelling if this operation is not nested.voidcreateAfter(IJavaElement sibling) Instructs this operation to position the new element after the given sibling, or to add the new element as the last child of its parent ifnull.voidcreateBefore(IJavaElement sibling) Instructs this operation to position the new element before the given sibling, or to add the new element as the last child of its parent ifnull.protected voidExecute the operation - generate new source for the compilation unit and save the results.protected abstract ASTNodegenerateElementAST(ASTRewrite rewriter, ICompilationUnit cu) protected voidprotected abstract IJavaElementCreates and returns the handle for the element this operation created.protected IJavaElement[]Creates and returns the handles for the elements this operation created.protected abstract StructuralPropertyDescriptorgetChildPropertyDescriptor(ASTNode parent) protected ICompilationUnitReturns the compilation unit in which the new element is being created.protected intReturns the amount of work for the main task of this operation for progress reporting.abstract StringReturns the name of the main task of this operation for progress reporting.protected org.eclipse.core.runtime.jobs.ISchedulingRuleprotected voidSets the default position in which to create the new type member.protected voidinsertASTNode(ASTRewrite rewriter, ASTNode parent, ASTNode child) Inserts the given child into the given AST, based on the position settings of this operation.protected CompilationUnitprotected voidsetAlteredName(String newName) Sets the name of theDOMNodethat will be used to create this new element.protected voidsetRelativePosition(IJavaElement sibling, int policy) Instructs this operation to position the new element relative to the given sibling, or to add the new element as the last child of its parent ifnull.verify()Possible failures: NO_ELEMENTS_TO_PROCESS - the compilation unit supplied to the operation isnull.Von Klasse geerbte Methoden 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, workedVon Klasse geerbte Methoden java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitVon Schnittstelle geerbte Methoden org.eclipse.core.runtime.IProgressMonitor
clearBlocked, setBlocked, slice
-
Felddetails
-
cuAST
The compilation unit AST used for this operation -
INSERT_LAST
protected static final int INSERT_LASTA constant meaning to position the new element as the last child of its parent element.- Siehe auch:
-
INSERT_AFTER
protected static final int INSERT_AFTERA constant meaning to position the new element after the element defined byfAnchorElement.- Siehe auch:
-
INSERT_BEFORE
protected static final int INSERT_BEFOREA constant meaning to position the new element before the element defined byfAnchorElement.- Siehe auch:
-
insertionPolicy
protected int insertionPolicyOne of the position constants, describing where to position the newly created element. -
anchorElement
The element that the newly created element is positioned relative to, as described byfInsertPosition, ornullif the newly created element will be positioned last. -
creationOccurred
protected boolean creationOccurredA flag indicating whether creation of a new element occurred. A request for creating a duplicate element would request in this flag being set tofalse. Ensures that no deltas are generated when creation does not occur.
-
-
Konstruktordetails
-
CreateElementInCUOperation
Constructs an operation that creates a Java Language Element with the specified parent, contained within a compilation unit.
-
-
Methodendetails
-
checkCanceled
protected void checkCanceled()Only allow cancelling if this operation is not nested.- Setzt außer Kraft:
checkCanceledin KlasseJavaModelOperation- Siehe auch:
-
IProgressMonitor.isCanceled()
-
createAfter
Instructs this operation to position the new element after the given sibling, or to add the new element as the last child of its parent ifnull. -
createBefore
Instructs this operation to position the new element before the given sibling, or to add the new element as the last child of its parent ifnull. -
executeOperation
Execute the operation - generate new source for the compilation unit and save the results.- Angegeben von:
executeOperationin KlasseJavaModelOperation- Löst aus:
JavaModelException- if the operation is unable to complete
-
getChildPropertyDescriptor
-
generateElementAST
protected abstract ASTNode generateElementAST(ASTRewrite rewriter, ICompilationUnit cu) throws JavaModelException - Löst aus:
JavaModelException
-
generateNewCompilationUnitAST
- Löst aus:
JavaModelException
-
generateResultHandle
Creates and returns the handle for the element this operation created. -
generateResultHandles
Creates and returns the handles for the elements this operation created. -
getCompilationUnit
Returns the compilation unit in which the new element is being created. -
getMainAmountOfWork
protected int getMainAmountOfWork()Returns the amount of work for the main task of this operation for progress reporting. -
getMainTaskName
Returns the name of the main task of this operation for progress reporting. -
getSchedulingRule
protected org.eclipse.core.runtime.jobs.ISchedulingRule getSchedulingRule()- Setzt außer Kraft:
getSchedulingRulein KlasseJavaModelOperation
-
initializeDefaultPosition
protected void initializeDefaultPosition()Sets the default position in which to create the new type member. Operations that require a different default position must override this method. -
insertASTNode
protected void insertASTNode(ASTRewrite rewriter, ASTNode parent, ASTNode child) throws JavaModelException Inserts the given child into the given AST, based on the position settings of this operation.- Löst aus:
JavaModelException- Siehe auch:
-
parse
- Löst aus:
JavaModelException
-
setAlteredName
Sets the name of theDOMNodethat will be used to create this new element. Used by theCopyElementsOperationfor renaming. Only used forCreateTypeMemberOperation -
setRelativePosition
protected void setRelativePosition(IJavaElement sibling, int policy) throws IllegalArgumentException Instructs this operation to position the new element relative to the given sibling, or to add the new element as the last child of its parent ifnull. Thepositionmust be one of the position constants.- Löst aus:
IllegalArgumentException
-
verify
Possible failures:- NO_ELEMENTS_TO_PROCESS - the compilation unit supplied to the operation is
null. - INVALID_NAME - no name, a name was null or not a valid import declaration name.
- INVALID_SIBLING - the sibling provided for positioning is not valid.
- Setzt außer Kraft:
verifyin KlasseJavaModelOperation- Siehe auch:
- NO_ELEMENTS_TO_PROCESS - the compilation unit supplied to the operation is
-