edu.cmu.sei.osate.workspace
Interface IAadlpathEntry


public interface IAadlpathEntry

An entry on a Java project aadlpath identifying one or more package fragment roots. A aadlpath entry has a content kind (either source, K_SOURCE, or binary, K_BINARY), which is inherited by each package fragment root and package fragment associated with the entry.

A aadlpath entry can refer to any of the following:

The result of IJavaProject#getResolvedpath will have all entries of type CPE_VARIABLE and CPE_CONTAINER resolved to a set of CPE_SOURCE, CPE_LIBRARY or CPE_PROJECT aadlpath entries.

Any aadlpath entry other than a source folder (kind CPE_SOURCE) can be marked as being exported. Exported entries are automatically contributed to dependent projects, along with the project's default output folder, which is implicitly exported, and any auxiliary output folders specified on source aadlpath entries. The project's output folder(s) are always listed first, followed by the any exported entries.

This interface is not intended to be implemented by clients. Aadlpath entries can be created via methods on JavaCore.


Field Summary
static int CPE_CONTAINER
          Entry kind constant describing a aadlpath entry representing a name aadlpath container.
static int CPE_LIBRARY
          Entry kind constant describing a aadlpath entry identifying a library.
static int CPE_PROJECT
          Entry kind constant describing a aadlpath entry identifying a required project.
static int CPE_SOURCE
          Entry kind constant describing a aadlpath entry identifying a folder containing package fragments with source code to be compiled.
static int CPE_VARIABLE
          Entry kind constant describing a aadlpath entry defined using a path that begins with a aadlpath variable reference.
 
Method Summary
 int getContentKind()
          Returns the kind of files found in the package fragments identified by this aadlpath entry.
 int getEntryKind()
          Returns the kind of this aadlpath entry.
 org.eclipse.core.runtime.IPath[] getExclusionPatterns()
          Returns the set of patterns used to exclude resources associated with this source entry.
 org.eclipse.core.runtime.IPath[] getInclusionPatterns()
          Returns the set of patterns used to explicitly define resources to be included with this source entry.
 org.eclipse.core.runtime.IPath getOutputLocation()
          Returns the full path to the specific location where the builder writes .class files generated for this source entry (entry kind CPE_SOURCE).
 org.eclipse.core.runtime.IPath getPath()
          Returns the path of this aadlpath entry.
 org.eclipse.core.runtime.IPath getSourceAttachmentPath()
          Returns the path to the source archive or folder associated with this aadlpath entry, or null if this aadlpath entry has no source attachment.
 org.eclipse.core.runtime.IPath getSourceAttachmentRootPath()
          Returns the path within the source archive or folder where package fragments are located.
 boolean isExported()
          Returns whether this entry is exported to dependent projects.
 

Field Detail

CPE_LIBRARY

static final int CPE_LIBRARY
Entry kind constant describing a aadlpath entry identifying a library. A library is a folder or JAR containing package fragments consisting of pre-compiled binaries.

See Also:
Constant Field Values

CPE_PROJECT

static final int CPE_PROJECT
Entry kind constant describing a aadlpath entry identifying a required project.

See Also:
Constant Field Values

CPE_SOURCE

static final int CPE_SOURCE
Entry kind constant describing a aadlpath entry identifying a folder containing package fragments with source code to be compiled.

See Also:
Constant Field Values

CPE_VARIABLE

static final int CPE_VARIABLE
Entry kind constant describing a aadlpath entry defined using a path that begins with a aadlpath variable reference.

See Also:
Constant Field Values

CPE_CONTAINER

static final int CPE_CONTAINER
Entry kind constant describing a aadlpath entry representing a name aadlpath container.

Since:
2.0
See Also:
Constant Field Values
Method Detail

getContentKind

int getContentKind()
Returns the kind of files found in the package fragments identified by this aadlpath entry.

Returns:
IPackageFragmentRoot.K_SOURCE for files containing source code, and IPackageFragmentRoot.K_BINARY for binary class files. There is no specified value for an entry denoting a variable (CPE_VARIABLE) or a aadlpath container (CPE_CONTAINER).

getEntryKind

int getEntryKind()
Returns the kind of this aadlpath entry.

Returns:
one of:
  • CPE_SOURCE - this entry describes a source root in its project
  • CPE_LIBRARY - this entry describes a folder or JAR containing binaries
  • CPE_PROJECT - this entry describes another project
  • CPE_VARIABLE - this entry describes a project or library indirectly via a aadlpath variable in the first segment of the path *
  • CPE_CONTAINER - this entry describes set of entries referenced indirectly via a aadlpath container

getExclusionPatterns

org.eclipse.core.runtime.IPath[] getExclusionPatterns()
Returns the set of patterns used to exclude resources associated with this source entry.

Exclusion patterns allow specified portions of the resource tree rooted at this source entry's path to be filtered out. If no exclusion patterns are specified, this source entry includes all relevent files. Each path specified must be a relative path, and will be interpreted relative to this source entry's path. File patterns are case-sensitive. A file matched by one or more of these patterns is excluded from the corresponding package fragment root. Exclusion patterns have higher precedence than inclusion patterns; in other words, exclusion patterns can remove files for the ones that are to be included, not the other way around.

Note that there is no need to supply a pattern to exclude ".class" files because a source entry filters these out automatically.

The pattern mechanism is similar to Ant's. Each pattern is represented as a relative path. The path segments can be regular file or folder names or simple patterns involving standard wildcard characters.

'*' matches 0 or more characters within a segment. So *.java matches .java, a.java and Foo.java, but not Foo.properties (does not end with .java).

'?' matches 1 character within a segment. So ?.java matches a.java, A.java, but not .java or xyz.java (neither have just one character before .java).

Combinations of *'s and ?'s are allowed.

The special pattern '**' matches zero or more segments. A path like tests/ that ends in a trailing separator is interpreted as tests/**, and would match all files under the the folder named tests.

Examples:

Returns:
the possibly empty list of resource exclusion patterns associated with this source entry, and null for other kinds of aadlpath entries
Since:
2.1

getInclusionPatterns

org.eclipse.core.runtime.IPath[] getInclusionPatterns()
Returns the set of patterns used to explicitly define resources to be included with this source entry.

When no inclusion patterns are specified, the source entry includes all relevent files in the resource tree rooted at this source entry's path. Specifying one or more inclusion patterns means that only the specified portions of the resource tree are to be included. Each path specified must be a relative path, and will be interpreted relative to this source entry's path. File patterns are case-sensitive. A file matched by one or more of these patterns is included in the corresponding package fragment root unless it is excluded by one or more of this entrie's exclusion patterns. Exclusion patterns have higher precedence than inclusion patterns; in other words, exclusion patterns can remove files for the ones that are to be included, not the other way around.

See getExclusionPatterns() for a discussion of the syntax and semantics of path patterns. The absence of any inclusion patterns is semantically equivalent to the explicit inclusion pattern **.

Examples:

Returns:
the possibly empty list of resource inclusion patterns associated with this source entry, and null for other kinds of aadlpath entries
Since:
3.0

getOutputLocation

org.eclipse.core.runtime.IPath getOutputLocation()
Returns the full path to the specific location where the builder writes .class files generated for this source entry (entry kind CPE_SOURCE).

Source entries can optionally be associated with a specific output location. If none is provided, the source entry will be implicitly associated with its project default output location (see IJavaProject#getOutputLocation).

NOTE: A specific output location cannot coincidate with another source/library entry.

Returns:
the full path to the specific location where the builder writes .class files for this source entry, or null if using default output folder
Since:
2.1

getPath

org.eclipse.core.runtime.IPath getPath()
Returns the path of this aadlpath entry. The meaning of the path of a aadlpath entry depends on its entry kind:

Returns:
the path of this aadlpath entry

getSourceAttachmentPath

org.eclipse.core.runtime.IPath getSourceAttachmentPath()
Returns the path to the source archive or folder associated with this aadlpath entry, or null if this aadlpath entry has no source attachment.

Only library and variable aadlpath entries may have source attachments. For library aadlpath entries, the result path (if present) locates a source archive or folder. This archive or folder can be located in a project of the workspace or outside thr workspace. For variable aadlpath entries, the result path (if present) has an analogous form and meaning as the variable path, namely the first segment is the name of a aadlpath variable.

Returns:
the path to the source archive or folder, or null if none

getSourceAttachmentRootPath

org.eclipse.core.runtime.IPath getSourceAttachmentRootPath()
Returns the path within the source archive or folder where package fragments are located. An empty path indicates that packages are located at the root of the source archive or folder. Returns a non-null value if and only if getSourceAttachmentPath returns a non-null value.

Returns:
the path within the source archive or folder, or null if not applicable

isExported

boolean isExported()
Returns whether this entry is exported to dependent projects. Always returns false for source entries (kind CPE_SOURCE), which cannot be exported.

Returns:
true if exported, and false otherwise
Since:
2.0