|
Eclipse JDT 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A package fragment is a portion of the workspace corresponding to an entire package, or to a portion thereof. The distinction between a package fragment and a package is that a package with some name is the union of all package fragments in the class path which have the same name.
Package fragments elements need to be opened before they can be navigated or manipulated.
The children are of type ICompilationUnit
(representing a source file) or
IClassFile
(representing a binary class file).
The children are listed in no particular order.
This interface is not intended to be implemented by clients.
Field Summary | |
static String |
DEFAULT_PACKAGE_NAME
The name of package fragment for the default package (value: the empty string, "" ). |
Fields inherited from interface org.eclipse.jdt.core.IJavaElement |
CLASS_FILE, COMPILATION_UNIT, FIELD, IMPORT_CONTAINER, IMPORT_DECLARATION, INITIALIZER, JAVA_MODEL, JAVA_PROJECT, METHOD, PACKAGE_DECLARATION, PACKAGE_FRAGMENT, PACKAGE_FRAGMENT_ROOT, TYPE |
Method Summary | |
boolean |
containsJavaResources()
Returns whether this fragment contains at least one Java resource. |
ICompilationUnit |
createCompilationUnit(String name,
String contents,
boolean force,
IProgressMonitor monitor)
Creates and returns a compilation unit in this package fragment with the specified name and contents. |
IClassFile |
getClassFile(String name)
Returns the class file with the specified name in this package (for example, "Object.class" ). |
IClassFile[] |
getClassFiles()
Returns all of the class files in this package fragment. |
ICompilationUnit |
getCompilationUnit(String name)
Returns the compilation unit with the specified name in this package (for example, "Object.java" ). |
ICompilationUnit[] |
getCompilationUnits()
Returns all of the compilation units in this package fragment. |
String |
getElementName()
Returns the dot-separated package name of this fragment, for example "java.lang" , or "" (the empty string),
for the default package. |
int |
getKind()
Returns this package fragment's root kind encoded as an integer. |
Object[] |
getNonJavaResources()
Returns an array of non-Java resources contained in this package fragment. |
boolean |
hasSubpackages()
Returns whether this package fragment's name is a prefix of other package fragments in this package fragment's root. |
boolean |
isDefaultPackage()
Returns whether this package fragment is a default package. |
Methods inherited from interface org.eclipse.jdt.core.IParent |
getChildren, hasChildren |
Methods inherited from interface org.eclipse.jdt.core.IJavaElement |
exists, getAncestor, getCorrespondingResource, getElementType, getHandleIdentifier, getJavaModel, getJavaProject, getOpenable, getParent, getPath, getResource, getUnderlyingResource, isReadOnly, isStructureKnown |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
getAdapter |
Methods inherited from interface org.eclipse.jdt.core.IOpenable |
close, getBuffer, hasUnsavedChanges, isConsistent, isOpen, makeConsistent, open, save |
Methods inherited from interface org.eclipse.jdt.core.ISourceManipulation |
copy, delete, move, rename |
Field Detail |
public static final String DEFAULT_PACKAGE_NAME
The name of package fragment for the default package (value: the empty
string, ""
).
Method Detail |
public boolean containsJavaResources() throws JavaModelException
JavaModelException
public ICompilationUnit createCompilationUnit(String name, String contents, boolean force, IProgressMonitor monitor) throws JavaModelException
It is possible that a compilation unit with the same name already exists in this
package fragment.
The value of the force
parameter effects the resolution of
such a conflict:
true
- in this case the compilation is created with the new contentsfalse
- in this case a JavaModelException
is thrown
contents
- the given contentsforce
- specify how to handle conflict is the same name already existsmonitor
- the given progress monitorname
- the given name
JavaModelException
- if the element could not be created. Reasons include:
CoreException
occurred while creating an underlying resource
null
(INVALID_CONTENTS)
public IClassFile getClassFile(String name)
"Object.class"
).
The ".class" suffix is required.
This is a handle-only method. The class file may or may not be present.
name
- the given name
public IClassFile[] getClassFiles() throws JavaModelException
Note: it is possible that a package fragment contains only
compilation units (i.e. its kind is K_SOURCE
), in
which case this method returns an empty collection.
JavaModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resource.public ICompilationUnit getCompilationUnit(String name)
"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.
name
- the given name
JavaConventions.validateCompilationUnitName(java.lang.String)
public ICompilationUnit[] getCompilationUnits() throws JavaModelException
Note: it is possible that a package fragment contains only
class files (i.e. its kind is K_BINARY
), in which
case this method returns an empty collection.
JavaModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resource.public String getElementName()
"java.lang"
, or ""
(the empty string),
for the default package.
getElementName
in interface IJavaElement
public int getKind() throws JavaModelException
.java
source files,
or .class
files. This is a convenience method.
JavaModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resource.IPackageFragmentRoot.K_SOURCE
,
IPackageFragmentRoot.K_BINARY
public Object[] getNonJavaResources() throws JavaModelException
JavaModelException
public boolean hasSubpackages() throws JavaModelException
JavaModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resource.public boolean isDefaultPackage()
|
Eclipse JDT 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |