Interface IPackageFragment

  • All Superinterfaces:
    IAdaptable, IJavaElement, IOpenable, IParent, ISourceManipulation

    public interface IPackageFragment
    extends IParent, IJavaElement, IOpenable, ISourceManipulation
    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.

    Restriction:
    This interface is not intended to be implemented by clients.
    • Field Detail

      • DEFAULT_PACKAGE_NAME

        static final String DEFAULT_PACKAGE_NAME

        The name of package fragment for the default package (value: the empty string, "").

        See Also:
        Constant Field Values
    • Method Detail

      • containsJavaResources

        boolean containsJavaResources()
                               throws JavaModelException
        Returns whether this fragment contains at least one Java resource.
        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.
      • createCompilationUnit

        ICompilationUnit createCompilationUnit​(String name,
                                               String contents,
                                               boolean force,
                                               IProgressMonitor monitor)
                                        throws JavaModelException
        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 a JavaModelException is thrown
        Parameters:
        contents - the given contents
        force - specify how to handle conflict is the same name already exists
        monitor - the given progress monitor
        name - the given name
        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)
      • getClassFile

        IClassFile getClassFile​(String name)
        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".

        Parameters:
        name - the given name
        Returns:
        the class file with the specified name in this package
      • getOrdinaryClassFile

        IOrdinaryClassFile getOrdinaryClassFile​(String name)
        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 use getModularClassFile().

        Parameters:
        name - the given name
        Returns:
        the class file with the specified name in this package
        Since:
        3.14
      • getModularClassFile

        IModularClassFile getModularClassFile()
        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 an IModuleDescription.
        Returns:
        the class file representing "module-info.class" in this package.
        Since:
        3.14
      • getAllClassFiles

        IClassFile[] getAllClassFiles()
                               throws JavaModelException
        Returns all of the class files in this package fragment.

        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.

        Note: the returned list may contain ordinary class files as well as a modular class file (for "module-info.class").

        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.
        Since:
        3.14
      • getClassFiles

        @Deprecated
        IClassFile[] getClassFiles()
                            throws JavaModelException
        Deprecated.
        Clients are advised to specifically use either getOrdinaryClassFiles() or getAllClassFiles() to express their intent.
        Returns all of the ordinary class files in this package fragment.

        Note: this list never includes a modular class file (see 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.

        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.
      • getOrdinaryClassFiles

        IOrdinaryClassFile[] getOrdinaryClassFiles()
                                            throws JavaModelException
        Returns all of the ordinary class files in this package fragment, i.e., not including the modular class file "module-info.class".

        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.

        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.
        Since:
        3.14
      • getCompilationUnits

        ICompilationUnit[] getCompilationUnits()
                                        throws JavaModelException
        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.

        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.
      • getCompilationUnits

        ICompilationUnit[] getCompilationUnits​(WorkingCopyOwner owner)
                                        throws JavaModelException
        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.

        Parameters:
        owner - the owner of the returned compilation units
        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.
        Since:
        3.0
      • getElementName

        String getElementName()
        Returns the dot-separated package name of this fragment, for example "java.lang", or "" (the empty string), for the default package.
        Specified by:
        getElementName in interface IJavaElement
        Returns:
        the dot-separated package name of this fragment
      • getNonJavaResources

        Object[] getNonJavaResources()
                              throws JavaModelException
        Returns an array of non-Java resources contained in this package fragment.

        Non-Java resources includes other files and folders located in the same directory as the compilation units or class files for this package fragment. Source files excluded from this package by virtue of inclusion/exclusion patterns on the corresponding source classpath entry are considered non-Java resources and will appear in the result (possibly in a folder).

        Since 3.3, if this package fragment is inside an archive, the non-Java resources are a tree of IJarEntryResources. One can navigate this tree using the IJarEntryResource.getChildren() and IJarEntryResource.getParent() methods.

        Returns:
        an array of non-Java resources (IFiles, IFolders, or IStorages 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()
      • hasSubpackages

        boolean hasSubpackages()
                        throws JavaModelException
        Returns whether this package fragment's name is a prefix of other package fragments in this package fragment's root.
        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.
      • isDefaultPackage

        boolean isDefaultPackage()
        Returns whether this package fragment is a default package. This is a handle-only method.
        Returns:
        true if this package fragment is a default package