Class PackageFragment
- All Implemented Interfaces:
IBufferChangedListener
,IJavaElement
,IOpenable
,IPackageFragment
,IParent
,ISourceManipulation
,SuffixConstants
,org.eclipse.core.runtime.IAdaptable
- See Also:
IPackageFragment
-
Field Summary
Modifier and TypeFieldDescriptionString[]
protected static IClassFile[]
Constant empty list of class filesprotected static ICompilationUnit[]
Constant empty list of compilation unitsprotected static IOrdinaryClassFile[]
Fields inherited from class org.aspectj.org.eclipse.jdt.internal.core.JavaElement
JEM_ANNOTATION, JEM_CLASSFILE, JEM_COMPILATIONUNIT, JEM_COUNT, JEM_DELIMITER_ESCAPE, JEM_ESCAPE, JEM_FIELD, JEM_IMPORTDECLARATION, JEM_INITIALIZER, JEM_JAVAPROJECT, JEM_LAMBDA_EXPRESSION, JEM_LAMBDA_METHOD, JEM_LOCALVARIABLE, JEM_METHOD, JEM_MODULAR_CLASSFILE, JEM_MODULE, JEM_PACKAGEDECLARATION, JEM_PACKAGEFRAGMENT, JEM_PACKAGEFRAGMENTROOT, JEM_STRING, JEM_TYPE, JEM_TYPE_PARAMETER, NO_ELEMENTS, NO_INFO, NO_STRINGS, parent
Fields inherited from interface org.aspectj.org.eclipse.jdt.core.IJavaElement
ANNOTATION, CLASS_FILE, COMPILATION_UNIT, FIELD, IMPORT_CONTAINER, IMPORT_DECLARATION, INITIALIZER, JAVA_MODEL, JAVA_MODULE, JAVA_PROJECT, LOCAL_VARIABLE, METHOD, PACKAGE_DECLARATION, PACKAGE_FRAGMENT, PACKAGE_FRAGMENT_ROOT, TYPE, TYPE_PARAMETER
Fields inherited from interface org.aspectj.org.eclipse.jdt.core.IPackageFragment
DEFAULT_PACKAGE_NAME
Fields inherited from interface org.aspectj.org.eclipse.jdt.internal.compiler.util.SuffixConstants
EXTENSION_aj, EXTENSION_AJ, EXTENSION_class, EXTENSION_CLASS, EXTENSION_java, EXTENSION_JAVA, EXTENSION_jmod, EXTENSION_JMOD, SUFFIX_aj, SUFFIX_AJ, SUFFIX_class, SUFFIX_CLASS, SUFFIX_java, SUFFIX_JAVA, SUFFIX_STRING_aj, SUFFIX_STRING_AJ, SUFFIX_STRING_class, SUFFIX_STRING_CLASS, SUFFIX_STRING_java, SUFFIX_STRING_JAVA
-
Constructor Summary
ModifierConstructorDescriptionprotected
PackageFragment(PackageFragmentRoot root, String[] names)
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
buildStructure(OpenableElementInfo info, org.eclipse.core.runtime.IProgressMonitor pm, Map newElements, org.eclipse.core.resources.IResource underlyingResource)
Builds this element's structure and properties in the given info object, based on this element's current contents (reuse buffer contents if this element has an open buffer, or resource contents if this element does not have an open buffer).boolean
Returns true if this fragment contains at least one java resource.void
copy(IJavaElement container, IJavaElement sibling, String rename, boolean force, org.eclipse.core.runtime.IProgressMonitor monitor)
Copies this element to the given container.createCompilationUnit(String cuName, String contents, boolean force, org.eclipse.core.runtime.IProgressMonitor monitor)
Creates and returns a compilation unit in this package fragment with the specified name and contents.protected Object
void
delete(boolean force, org.eclipse.core.runtime.IProgressMonitor monitor)
Deletes this element, forcing if specified and necessary.boolean
Returns true if this handle represents the same Java element as the given handle.boolean
exists()
Returns whether this Java element exists in the model.Returns a collection of all class files in this - a folder package fragment which has a root that has its kind set toIPackageFragmentRoot.K_Source
does not recognize class files.getAttachedJavadoc(org.eclipse.core.runtime.IProgressMonitor monitor)
Returns the Javadoc as HTML source if this element has attached Javadoc,null
otherwise.getClassFile(String classFileName)
Returns the class file with the specified name in this package (for example,"Object.class"
).Deprecated.getCompilationUnit(String cuName)
Returns the compilation unit with the specified name in this package (for example,"Object.java"
).Returns all of the compilation units in this package fragment.getCompilationUnits(WorkingCopyOwner owner)
Returns all of the compilation units in this package fragment that are in working copy mode and that have the given owner.Returns the name of this element.int
Returns this element's kind encoded as an integer.getHandleFromMemento(String token, MementoTokenizer memento, WorkingCopyOwner owner)
protected char
Returns thechar
that marks the start of this handles contribution to a memento.int
getKind()
Returns this package fragment's root kind encoded as an integer.Returns the class file for"module-info.class"
in this package.Object[]
Returns an array of non-java resources contained in the receiver.getOrdinaryClassFile(String classFileName)
Returns the class file with the specified name in this package (for example,"Object.class"
).Returns a collection of ordinary class files in this - a folder package fragment which has a root that has its kind set toIPackageFragmentRoot.K_Source
does not recognize class files.org.eclipse.core.runtime.IPath
getPath()
Returns the path to the innermost resource enclosing this element.org.eclipse.core.resources.IResource
Returns the smallest underlying resource that contains this element, ornull
if this element is not contained in a resource.boolean
Returns whether this element has one or more immediate children.int
hashCode()
Returns the hash code for this Java element.boolean
Returns whether this package fragment's name is a prefix of other package fragments in this package fragment's root.protected boolean
boolean
Returns whether this package fragment is a default package.protected boolean
void
move(IJavaElement container, IJavaElement sibling, String rename, boolean force, org.eclipse.core.runtime.IProgressMonitor monitor)
Moves this element to the given container.void
Renames this element to the given name.org.eclipse.core.resources.IResource
resource(PackageFragmentRoot root)
protected void
toStringChildren(int tab, StringBuffer buffer, Object info)
Debugging purposesprotected void
toStringInfo(int tab, StringBuffer buffer, Object info, boolean showResolvedInfo)
Debugging purposesprotected org.eclipse.core.runtime.IStatus
validateExistence(org.eclipse.core.resources.IResource underlyingResource)
Methods inherited from class org.aspectj.org.eclipse.jdt.internal.core.Openable
bufferChanged, canBeRemovedFromCache, canBufferBeRemovedFromCache, closeBuffer, closing, codeComplete, codeSelect, findRecommendedLineSeparator, generateInfos, getBuffer, getBufferFactory, getBufferManager, getCorrespondingResource, getOpenable, getPackageFragmentRoot, getResource, hasBuffer, hasUnsavedChanges, ignoreErrorStatus, isConsistent, isOpen, isSourceElement, isStructureKnown, makeConsistent, open, openAncestors, openBuffer, resource, resourceExists, save
Methods inherited from class org.aspectj.org.eclipse.jdt.internal.core.JavaElement
appendEscapedDelimiter, close, escapeMementoName, findNode, getAncestor, getChildren, getChildrenOfType, getClassFile, getCompilationUnit, getElementInfo, getElementInfo, getHandleFromMemento, getHandleIdentifier, getHandleMemento, getHandleMemento, getJavadocBaseLocation, getJavaModel, getJavaProject, getLibraryJavadocLocation, getOpenableParent, getParent, getPrimaryElement, getPrimaryElement, getSchedulingRule, getSourceElementAt, getSourceMapper, getURLContents, isAncestorOf, isReadOnly, newDoesNotExistStatus, newJavaModelException, newNotPresentException, openWhenClosed, readableName, resolved, tabString, toDebugString, toString, toString, toStringAncestors, toStringInfo, toStringName, toStringWithAncestors, toStringWithAncestors, unresolved, validateAndCache
Methods inherited from class org.eclipse.core.runtime.PlatformObject
getAdapter
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
Methods inherited from interface org.aspectj.org.eclipse.jdt.core.IJavaElement
getAncestor, getCorrespondingResource, getHandleIdentifier, getJavaModel, getJavaProject, getOpenable, getParent, getPrimaryElement, getResource, getSchedulingRule, isReadOnly, isStructureKnown
Methods inherited from interface org.aspectj.org.eclipse.jdt.core.IOpenable
close, findRecommendedLineSeparator, getBuffer, hasUnsavedChanges, isConsistent, isOpen, makeConsistent, open, save
Methods inherited from interface org.aspectj.org.eclipse.jdt.core.IParent
getChildren
-
Field Details
-
NO_CLASSFILES
Constant empty list of class files -
NO_ORDINARY_CLASSFILES
-
NO_COMPILATION_UNITS
Constant empty list of compilation units -
names
-
-
Constructor Details
-
PackageFragment
-
-
Method Details
-
buildStructure
protected boolean buildStructure(OpenableElementInfo info, org.eclipse.core.runtime.IProgressMonitor pm, Map newElements, org.eclipse.core.resources.IResource underlyingResource) throws JavaModelExceptionDescription copied from class:Openable
Builds this element's structure and properties in the given info object, based on this element's current contents (reuse buffer contents if this element has an open buffer, or resource contents if this element does not have an open buffer). Children are placed in the given newElements table (note, this element has already been placed in the newElements table). Returns true if successful, or false if an error is encountered while determining the structure of this element.- Specified by:
buildStructure
in classOpenable
- Throws:
JavaModelException
- See Also:
Openable
-
containsJavaResources
Returns true if this fragment contains at least one java resource. Returns false otherwise.- Specified by:
containsJavaResources
in interfaceIPackageFragment
- Returns:
- true if this fragment contains at least one Java resource, false otherwise
- Throws:
JavaModelException
- if this element does not exist or if an exception occurs while accessing its corresponding resource.
-
copy
public void copy(IJavaElement container, IJavaElement sibling, String rename, boolean force, org.eclipse.core.runtime.IProgressMonitor monitor) throws JavaModelExceptionDescription copied from interface:ISourceManipulation
Copies this element to the given container.- Specified by:
copy
in interfaceISourceManipulation
- Parameters:
container
- the containersibling
- the sibling element before which the copy should be inserted, ornull
if the copy should be inserted as the last child of the containerrename
- the new name for the element, ornull
if the copy retains the name of this elementforce
-true
if any existing child in the container with the target name should be replaced, andfalse
to throw an exception in the event of a name collisionmonitor
- a progress monitor- Throws:
JavaModelException
- if this element could not be copied. Reasons include:- This Java element, container element, or sibling does not exist (ELEMENT_DOES_NOT_EXIST)
- A
CoreException
occurred while updating an underlying resource - The container is of an incompatible type (INVALID_DESTINATION)
- The sibling is not a child of the given container (INVALID_SIBLING)
- The new name is invalid (INVALID_NAME)
- A child in the container already exists with the same name (NAME_COLLISION)
and
replace
has been specified asfalse
- The container or this element is read-only (READ_ONLY)
- See Also:
ISourceManipulation
-
createCompilationUnit
public ICompilationUnit createCompilationUnit(String cuName, String contents, boolean force, org.eclipse.core.runtime.IProgressMonitor monitor) throws JavaModelExceptionDescription copied from interface:IPackageFragment
Creates and returns a compilation unit in this package fragment with the specified name and contents. No verification is performed on the contents.It is possible that a compilation unit with the same name already exists in this package fragment. The value of the
force
parameter affects the resolution of such a conflict:-
true
- in this case the compilation is created with the new contents -
false
- in this case aJavaModelException
is thrown
- Specified by:
createCompilationUnit
in interfaceIPackageFragment
- Parameters:
cuName
- the given namecontents
- the given contentsforce
- specify how to handle conflict is the same name already existsmonitor
- the given progress monitor- Returns:
- a compilation unit in this package fragment with the specified name and contents
- Throws:
JavaModelException
- if the element could not be created. Reasons include:- This Java element does not exist (ELEMENT_DOES_NOT_EXIST)
- A
CoreException
occurred while creating an underlying resource - The name is not a valid compilation unit name (INVALID_NAME)
- The contents are
null
(INVALID_CONTENTS)
- See Also:
IPackageFragment
-
-
createElementInfo
- Overrides:
createElementInfo
in classOpenable
- See Also:
JavaElement
-
delete
public void delete(boolean force, org.eclipse.core.runtime.IProgressMonitor monitor) throws JavaModelExceptionDescription copied from interface:ISourceManipulation
Deletes this element, forcing if specified and necessary.- Specified by:
delete
in interfaceISourceManipulation
- Parameters:
force
- a flag controlling whether underlying resources that are not in sync with the local file system will be tolerated (same as the force flag in IResource operations).monitor
- a progress monitor- Throws:
JavaModelException
- if this element could not be deleted. Reasons include:- This Java element does not exist (ELEMENT_DOES_NOT_EXIST)
- A
CoreException
occurred while updating an underlying resource (CORE_EXCEPTION) - This element is read-only (READ_ONLY)
- See Also:
ISourceManipulation
-
equals
Description copied from class:JavaElement
Returns true if this handle represents the same Java element as the given handle. By default, two handles represent the same element if they are identical or if they represent the same type of element, have equal names, parents, and occurrence counts.If a subclass has other requirements for equality, this method must be overridden.
- Overrides:
equals
in classJavaElement
- See Also:
Object.equals(java.lang.Object)
-
exists
public boolean exists()Description copied from interface:IJavaElement
Returns whether this Java element exists in the model.Java elements are handle objects that may or may not be backed by an actual element. Java elements that are backed by an actual element are said to "exist", and this method returns
true
. For Java elements that are not working copies, it is always the case that if the element exists, then its parent also exists (provided it has one) and includes the element as one of its children. It is therefore possible to navigated to any existing Java element from the root of the Java model along a chain of existing Java elements. On the other hand, working copies are said to exist until they are destroyed (withIWorkingCopy.destroy
). Unlike regular Java elements, a working copy never shows up among the children of its parent element (which may or may not exist).- Specified by:
exists
in interfaceIJavaElement
- Overrides:
exists
in classOpenable
- Returns:
true
if this element exists in the Java model, andfalse
if this element does not exist- See Also:
IJavaElement
-
getOrdinaryClassFile
Description copied from interface:IPackageFragment
Returns the class file with the specified name in this package (for example,"Object.class"
). The ".class" suffix is required. This is a handle-only method. The class file may or may not be present.This method is not applicable to the files
"module-info.class"
as introduced in Java 9. For those please useIPackageFragment.getModularClassFile()
.- Specified by:
getOrdinaryClassFile
in interfaceIPackageFragment
- Parameters:
classFileName
- the given name- Returns:
- the class file with the specified name in this package
- Throws:
IllegalArgumentException
- if the name does not end with ".class" or if the name is "module-info.class".- See Also:
IPackageFragment.getOrdinaryClassFile(String)
-
getClassFile
Description copied from interface:IPackageFragment
Returns the class file with the specified name in this package (for example,"Object.class"
). The ".class" suffix is required. This is a handle-only method. The class file may or may not be present.This method can handle ordinary class files or modular class files denoted by the name
"module-info.class"
.- Specified by:
getClassFile
in interfaceIPackageFragment
- Parameters:
classFileName
- the given name- Returns:
- the class file with the specified name in this package
- Throws:
IllegalArgumentException
- if the name does not end with ".class".- See Also:
IPackageFragment.getClassFile(String)
-
getModularClassFile
Description copied from interface:IPackageFragment
Returns the class file for"module-info.class"
in this package. This is a handle-only method. The class file may or may not be present. If the class file is present, then it is guaranteed to contain anIModuleDescription
.- Specified by:
getModularClassFile
in interfaceIPackageFragment
- Returns:
- the class file representing "module-info.class" in this package.
-
getOrdinaryClassFiles
Returns a collection of ordinary class files in this - a folder package fragment which has a root that has its kind set toIPackageFragmentRoot.K_Source
does not recognize class files.- Specified by:
getOrdinaryClassFiles
in interfaceIPackageFragment
- Returns:
- all of the ordinary class files in this package fragment
- Throws:
JavaModelException
- if this element does not exist or if an exception occurs while accessing its corresponding resource.- See Also:
IPackageFragment.getOrdinaryClassFiles()
-
getAllClassFiles
Returns a collection of all class files in this - a folder package fragment which has a root that has its kind set toIPackageFragmentRoot.K_Source
does not recognize class files.- Specified by:
getAllClassFiles
in interfaceIPackageFragment
- Returns:
- all of the class files in this package fragment
- Throws:
JavaModelException
- if this element does not exist or if an exception occurs while accessing its corresponding resource.- See Also:
IPackageFragment.getAllClassFiles()
-
getClassFiles
Deprecated.Description copied from interface:IPackageFragment
Returns all of the ordinary class files in this package fragment.Note: this list never includes a modular class file (see
IPackageFragment.getModularClassFile()
).Note: it is possible that a package fragment contains only compilation units (in other words, its kind is
K_SOURCE
), in which case this method returns an empty collection.- Specified by:
getClassFiles
in interfaceIPackageFragment
- Returns:
- all of the ordinary class files in this package fragment
- Throws:
JavaModelException
- if this element does not exist or if an exception occurs while accessing its corresponding resource.
-
getCompilationUnit
Description copied from interface:IPackageFragment
Returns the compilation unit with the specified name in this package (for example,"Object.java"
). The name has to be a valid compilation unit name. This is a handle-only method. The compilation unit may or may not be present.- Specified by:
getCompilationUnit
in interfaceIPackageFragment
- Parameters:
cuName
- the given name- Returns:
- the compilation unit with the specified name in this package
- Throws:
IllegalArgumentException
- if the name does not end with ".java"- See Also:
IPackageFragment.getCompilationUnit(String)
-
getCompilationUnits
Description copied from interface:IPackageFragment
Returns all of the compilation units in this package fragment.Note: it is possible that a package fragment contains only class files (in other words, its kind is
K_BINARY
), in which case this method returns an empty collection.- Specified by:
getCompilationUnits
in interfaceIPackageFragment
- Returns:
- all of the compilation units in this package fragment
- Throws:
JavaModelException
- if this element does not exist or if an exception occurs while accessing its corresponding resource.- See Also:
IPackageFragment.getCompilationUnits()
-
getCompilationUnits
Description copied from interface:IPackageFragment
Returns all of the compilation units in this package fragment that are in working copy mode and that have the given owner.Only existing working copies are returned. So a compilation unit handle that has no corresponding resource on disk will be included if and only if is in working copy mode.
Note: it is possible that a package fragment contains only class files (in other words, its kind is
K_BINARY
), in which case this method returns an empty collection.- Specified by:
getCompilationUnits
in interfaceIPackageFragment
- Parameters:
owner
- the owner of the returned compilation units- Returns:
- all of the compilation units in this package fragment
- See Also:
IPackageFragment.getCompilationUnits(WorkingCopyOwner)
-
getElementName
Description copied from interface:IJavaElement
Returns the name of this element. This is a handle-only method.- Specified by:
getElementName
in interfaceIJavaElement
- Specified by:
getElementName
in interfaceIPackageFragment
- Overrides:
getElementName
in classJavaElement
- Returns:
- the element name
- See Also:
IAdaptable
-
getElementType
public int getElementType()Description copied from interface:IJavaElement
Returns this element's kind encoded as an integer. This is a handle-only method.- Specified by:
getElementType
in interfaceIJavaElement
- Returns:
- the kind of element; one of the constants declared in
IJavaElement
- See Also:
IJavaElement
-
getHandleFromMemento
public IJavaElement getHandleFromMemento(String token, MementoTokenizer memento, WorkingCopyOwner owner)- Specified by:
getHandleFromMemento
in classJavaElement
-
getHandleMementoDelimiter
protected char getHandleMementoDelimiter()Description copied from class:JavaElement
Returns thechar
that marks the start of this handles contribution to a memento.- Specified by:
getHandleMementoDelimiter
in classJavaElement
- See Also:
JavaElement.getHandleMementoDelimiter()
-
getKind
Description copied from interface:IPackageFragment
Returns this package fragment's root kind encoded as an integer. A package fragment can contain source files (i.e. files with one of theJava-like extensions
), or.class
files. This is a convenience method.- Specified by:
getKind
in interfaceIPackageFragment
- Returns:
- this package fragment's root kind encoded as an integer
- Throws:
JavaModelException
- if this element does not exist or if an exception occurs while accessing its corresponding resource.- See Also:
IPackageFragment.getKind()
-
getNonJavaResources
Returns an array of non-java resources contained in the receiver.- Specified by:
getNonJavaResources
in interfaceIPackageFragment
- Returns:
- an array of non-Java resources (
IFile
s,IFolder
s, orIStorage
s if the package fragment is in an archive) contained in this package fragment - Throws:
JavaModelException
- if this element does not exist or if an exception occurs while accessing its corresponding resource.- See Also:
IClasspathEntry.getInclusionPatterns()
,IClasspathEntry.getExclusionPatterns()
-
getPath
public org.eclipse.core.runtime.IPath getPath()Description copied from interface:IJavaElement
Returns the path to the innermost resource enclosing this element. If this element is not included in an external library, the path returned is the full, absolute path to the underlying resource, relative to the workbench. If this element is included in an external library, the path returned is the absolute path to the archive or to the folder in the file system. This is a handle-only method.- Specified by:
getPath
in interfaceIJavaElement
- Returns:
- the path to the innermost resource enclosing this element
- See Also:
IJavaElement.getPath()
-
resource
- Specified by:
resource
in classOpenable
- See Also:
JavaElement.resource()
-
getUnderlyingResource
Description copied from interface:IJavaElement
Returns the smallest underlying resource that contains this element, ornull
if this element is not contained in a resource.- Specified by:
getUnderlyingResource
in interfaceIJavaElement
- Overrides:
getUnderlyingResource
in classOpenable
- Returns:
- the underlying resource, or
null
if none - Throws:
JavaModelException
- if this element does not exist or if an exception occurs while accessing its underlying resource- See Also:
IJavaElement.getUnderlyingResource()
-
hashCode
public int hashCode()Description copied from class:JavaElement
Returns the hash code for this Java element. By default, the hash code for an element is a combination of its name and parent's hash code. Elements with other requirements must override this method.- Overrides:
hashCode
in classJavaElement
-
hasChildren
Description copied from interface:IParent
Returns whether this element has one or more immediate children. This is a convenience method, and may be more efficient than testing whethergetChildren
is an empty array.- Specified by:
hasChildren
in interfaceIParent
- Overrides:
hasChildren
in classJavaElement
- Returns:
- true if the immediate children of this element, false otherwise
- Throws:
JavaModelException
- if this element does not exist or if an exception occurs while accessing its corresponding resource- See Also:
IParent
-
hasSubpackages
Description copied from interface:IPackageFragment
Returns whether this package fragment's name is a prefix of other package fragments in this package fragment's root.- Specified by:
hasSubpackages
in interfaceIPackageFragment
- Returns:
- true if this package fragment's name is a prefix of other package fragments in this package fragment's root, false otherwise
- Throws:
JavaModelException
- if this element does not exist or if an exception occurs while accessing its corresponding resource.- See Also:
IPackageFragment.hasSubpackages()
-
internalIsValidPackageName
protected boolean internalIsValidPackageName() -
isDefaultPackage
public boolean isDefaultPackage()Description copied from interface:IPackageFragment
Returns whether this package fragment is a default package. This is a handle-only method.- Specified by:
isDefaultPackage
in interfaceIPackageFragment
- Returns:
- true if this package fragment is a default package
- See Also:
IPackageFragment.isDefaultPackage()
-
isValidPackageName
protected final boolean isValidPackageName() -
move
public void move(IJavaElement container, IJavaElement sibling, String rename, boolean force, org.eclipse.core.runtime.IProgressMonitor monitor) throws JavaModelExceptionDescription copied from interface:ISourceManipulation
Moves this element to the given container.- Specified by:
move
in interfaceISourceManipulation
- Parameters:
container
- the containersibling
- the sibling element before which the element should be inserted, ornull
if the element should be inserted as the last child of the containerrename
- the new name for the element, ornull
if the element retains its nameforce
-true
if any existing child in the container with the target name should be replaced, andfalse
to throw an exception in the event of a name collisionmonitor
- a progress monitor- Throws:
JavaModelException
- if this element could not be moved. Reasons include:- This Java element, container element, or sibling does not exist (ELEMENT_DOES_NOT_EXIST)
- A
CoreException
occurred while updating an underlying resource - The container is of an incompatible type (INVALID_DESTINATION)
- The sibling is not a child of the given container (INVALID_SIBLING)
- The new name is invalid (INVALID_NAME)
- A child in the container already exists with the same name (NAME_COLLISION)
and
replace
has been specified asfalse
- The container or this element is read-only (READ_ONLY)
- See Also:
ISourceManipulation.move(IJavaElement, IJavaElement, String, boolean, IProgressMonitor)
-
rename
public void rename(String newName, boolean force, org.eclipse.core.runtime.IProgressMonitor monitor) throws JavaModelExceptionDescription copied from interface:ISourceManipulation
Renames this element to the given name.- Specified by:
rename
in interfaceISourceManipulation
- Parameters:
newName
- the new name for the elementforce
-true
if any existing element with the target name should be replaced, andfalse
to throw an exception in the event of a name collisionmonitor
- a progress monitor- Throws:
JavaModelException
- if this element could not be renamed. Reasons include:- This Java element does not exist (ELEMENT_DOES_NOT_EXIST)
- A
CoreException
occurred while updating an underlying resource - The new name is invalid (INVALID_NAME)
- A child in the container already exists with the same name (NAME_COLLISION)
and
replace
has been specified asfalse
- This element is read-only (READ_ONLY)
- See Also:
ISourceManipulation.rename(String, boolean, IProgressMonitor)
-
toStringChildren
Debugging purposes- Overrides:
toStringChildren
in classJavaElement
-
toStringInfo
Debugging purposes- Overrides:
toStringInfo
in classJavaElement
showResolvedInfo
- TODO
-
getAttachedJavadoc
public String getAttachedJavadoc(org.eclipse.core.runtime.IProgressMonitor monitor) throws JavaModelExceptionDescription copied from interface:IJavaElement
Returns the Javadoc as HTML source if this element has attached Javadoc,
null
otherwise.This should be used only for binary elements. Source elements will always return
null
.The encoding used to read the Javadoc is the one defined by the content type of the file. If none is defined, then the project's encoding of this Java element is used. If the project's encoding cannot be retrieved, then the platform encoding is used.
In case the Javadoc doesn't exist for this element,
null
is returned.The HTML is extracted from the attached Javadoc and provided as is. No transformation or validation is done.
- Specified by:
getAttachedJavadoc
in interfaceIJavaElement
- Overrides:
getAttachedJavadoc
in classJavaElement
- Parameters:
monitor
- the given progress monitor, can benull
- Returns:
- the extracted javadoc from the attached javadoc,
null
if none - Throws:
JavaModelException
- if:- this element does not exist
- retrieving the attached javadoc fails (timed-out, invalid URL, ...)
- the format of the javadoc doesn't match expected standards (different anchors,...)
- See Also:
IClasspathAttribute.JAVADOC_LOCATION_ATTRIBUTE_NAME
-
validateExistence
protected org.eclipse.core.runtime.IStatus validateExistence(org.eclipse.core.resources.IResource underlyingResource)- Specified by:
validateExistence
in classOpenable
-