Eclipse CDT
Pre-release 3.0

org.eclipse.cdt.core.model
Interface ILibraryEntry

All Superinterfaces:
IPathEntry

public interface ILibraryEntry
extends IPathEntry


Field Summary
 
Fields inherited from interface org.eclipse.cdt.core.model.IPathEntry
CDT_CONTAINER, CDT_INCLUDE, CDT_INCLUDE_FILE, CDT_LIBRARY, CDT_MACRO, CDT_MACRO_FILE, CDT_OUTPUT, CDT_PROJECT, CDT_SOURCE
 
Method Summary
 IPath getBasePath()
          Return the base path of the library.
 IPath getBaseReference()
          Return the base reference.
 IPath getFullLibraryPath()
          Returns the complete path, equivalent to: getBasepath().append(getPath());
 IPath getLibraryPath()
          Return the library path.
 IPath getSourceAttachmentPath()
          Returns the path to the source archive or folder associated with this C path entry, or null if this C path entry has no source attachment.
 IPath getSourceAttachmentPrefixMapping()
          Returns the path to map the source paths with to the source achive or folder An empty path indicates that the is a one-to-one mapping of source paths to the source achive or folder path.
 IPath getSourceAttachmentRootPath()
          Returns the path within the source archive or folder where source are located.
 
Methods inherited from interface org.eclipse.cdt.core.model.IPathEntry
getEntryKind, getPath, isExported
 

Method Detail

getSourceAttachmentPath

IPath getSourceAttachmentPath()
Returns the path to the source archive or folder associated with this C path entry, or null if this C path entry has no source attachment.

Only library and variable C path entries may have source attachments. For library C path 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 c path 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 c path variable.

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

getSourceAttachmentRootPath

IPath getSourceAttachmentRootPath()
Returns the path within the source archive or folder where source 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

getSourceAttachmentPrefixMapping

IPath getSourceAttachmentPrefixMapping()
Returns the path to map the source paths with to the source achive or folder An empty path indicates that the is a one-to-one mapping of source paths to the source achive or folder path. Returns a non-null value if and only if getSourceAttachmentPath returns a non-null value.

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

getBasePath

IPath getBasePath()
Return the base path of the library.

Returns:
IPath

getBaseReference

IPath getBaseReference()
Return the base reference.

Returns:

getLibraryPath

IPath getLibraryPath()
Return the library path.

Returns:

getFullLibraryPath

IPath getFullLibraryPath()
Returns the complete path, equivalent to: getBasepath().append(getPath());

Returns:

Eclipse CDT
Pre-release 3.0

Copyright (c) IBM Corp. and others 2004. All Rights Reserved.