|
Eclipse CDT 7.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ICProject
A C project represents a view of a project resource in terms of C
elements such as , ICContainer, ITranslationUnit ....
CoreModel.create(project)
.
CoreModel#create(org.eclipse.core.resources.IProject)
Field Summary |
---|
Method Summary | |
---|---|
ICElement |
findElement(IPath path)
Returns the ICElement corresponding to the given
path, or null if no such
ICElement is found. |
ISourceRoot |
findSourceRoot(IPath path)
|
ISourceRoot |
findSourceRoot(IResource resource)
|
ISourceRoot[] |
getAllSourceRoots()
Returns all of the existing source roots that exist on the project, in the order they are defined by the ".cdtproject". |
IArchiveContainer |
getArchiveContainer()
Return the ArchiveContainer of this Project. |
IBinaryContainer |
getBinaryContainer()
Return the BinaryContainer of this Project. |
IIncludeReference[] |
getIncludeReferences()
Return the include paths set on the project. |
ILibraryReference[] |
getLibraryReferences()
Return the library references for this project. |
java.lang.Object[] |
getNonCResources()
Returns an array of non-C resources directly contained in this project. |
java.lang.String |
getOption(java.lang.String optionName,
boolean inheritCCoreOptions)
Helper method for returning one option value only. |
java.util.Map<java.lang.String,java.lang.String> |
getOptions(boolean inheritCCoreOptions)
Returns the table of the current custom options for this project. |
IOutputEntry[] |
getOutputEntries()
Return the output entries. |
IProject |
getProject()
|
IPathEntry[] |
getRawPathEntries()
Returns the list of entries for the project. |
java.lang.String[] |
getRequiredProjectNames()
Returns the names of the projects that are directly required by this project. |
IPathEntry[] |
getResolvedPathEntries()
Returns the list of entries for the project. |
ISourceRoot |
getSourceRoot(ISourceEntry entry)
|
ISourceRoot[] |
getSourceRoots()
Returns the source root folders of the project. |
boolean |
isOnOutputEntry(IResource resource)
|
boolean |
isOnSourceRoot(IResource resource)
|
void |
setOption(java.lang.String optionName,
java.lang.String optionValue)
Helper method for setting one option value only. |
void |
setOptions(java.util.Map<java.lang.String,java.lang.String> newOptions)
Sets the project custom options. |
void |
setRawPathEntries(IPathEntry[] entries,
IProgressMonitor monitor)
Sets the entries for this project. |
Methods inherited from interface org.eclipse.cdt.core.model.IParent |
---|
getChildren, getChildrenOfType, hasChildren |
Methods inherited from interface org.eclipse.cdt.core.model.IOpenable |
---|
close, getBuffer, hasUnsavedChanges, isConsistent, isOpen, makeConsistent, makeConsistent, open, save |
Methods inherited from interface org.eclipse.cdt.core.model.IBufferChangedListener |
---|
bufferChanged |
Methods inherited from interface org.eclipse.cdt.core.model.ICElement |
---|
accept, exists, getAncestor, getCModel, getCProject, getElementName, getElementType, getHandleIdentifier, getLocationURI, getParent, getPath, getResource, getUnderlyingResource, isReadOnly, isStructureKnown |
Method Detail |
---|
ICElement findElement(IPath path) throws CModelException
ICElement
corresponding to the given
path, or null
if no such
ICElement
is found.
CModelException
- if the given path is null
or absoluteIArchiveContainer getArchiveContainer() throws CModelException
CModelException
IBinaryContainer getBinaryContainer() throws CModelException
CModelException
ISourceRoot[] getSourceRoots() throws CModelException
NOTE: This is equivalent to getChildren()
.
CModelException
ISourceRoot[] getAllSourceRoots() throws CModelException
CModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resourceISourceRoot getSourceRoot(ISourceEntry entry) throws CModelException
entry
-
CModelException
ISourceRoot findSourceRoot(IResource resource)
ISourceRoot findSourceRoot(IPath path)
IOutputEntry[] getOutputEntries() throws CModelException
CModelException
boolean isOnOutputEntry(IResource resource)
resource
- boolean isOnSourceRoot(IResource resource)
resource
- ILibraryReference[] getLibraryReferences() throws CModelException
CModelException
IIncludeReference[] getIncludeReferences() throws CModelException
CModelException
java.lang.String[] getRequiredProjectNames() throws CModelException
The project names are returned in the order they appear on the cpathentries.
CModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resourceIProject getProject()
java.lang.String getOption(java.lang.String optionName, boolean inheritCCoreOptions)
(String)this.getOptions(inheritCCoreOptions).get(optionName)
Note that it may answer null
if this option does not exist, or if there is no custom value for it.
For a complete description of the configurable options, see CCorePlugin#getDefaultOptions
.
optionName
- the name of an optioninheritCCoreOptions
- - boolean indicating whether CCorePlugin options should be inherited as well
CCorePlugin#getDefaultOptions
java.util.Map<java.lang.String,java.lang.String> getOptions(boolean inheritCCoreOptions)
CCorePlugin
.
For a complete description of the configurable options, see CCorePlugin#getDefaultOptions
.
inheritCCoreOptions
- - boolean indicating whether CCorePlugin options should be inherited as well
String
; value type: String
)CCorePlugin#getDefaultOptions
void setOption(java.lang.String optionName, java.lang.String optionValue)
Map options = this.getOptions(false); map.put(optionName, optionValue); this.setOptions(map)
For a complete description of the configurable options, see CCorePlugin#getDefaultOptions
.
optionName
- the name of an optionoptionValue
- the value of the option to setCCorePlugin#getDefaultOptions
void setOptions(java.util.Map<java.lang.String,java.lang.String> newOptions)
For a complete description of the configurable options, see CCorePlugin#getDefaultOptions
.
newOptions
- the new options (key type: String
; value type: String
),
or null
to flush all custom options (clients will automatically get the global CCorePlugin options).CCorePlugin#getDefaultOptions
IPathEntry[] getResolvedPathEntries() throws CModelException
setCPathEntries
.
CModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resourceIPathEntry[] getRawPathEntries() throws CModelException
setCPathEntries
.
CModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resourcevoid setRawPathEntries(IPathEntry[] entries, IProgressMonitor monitor) throws CModelException
entries
- a list of IPathEntry[] entriesmonitor
- the given progress monitor
CModelException
- if the entries could not be set. Reasons include:
java.lang.Object[] getNonCResources() throws CModelException
Non-C resources includes files, folders, projects not accounted for.
CModelException
- if this element does not exist or if an
exception occurs while accessing its corresponding resource
|
Eclipse CDT 7.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |