org.netbeans.modules.cnd.api.model/1 1.3 1

org.netbeans.modules.cnd.api.model
Interface CsmProject

All Superinterfaces:
CsmIdentifiable<CsmProject>, CsmNamedElement, CsmObject, CsmValidable

public interface CsmProject
extends CsmIdentifiable<CsmProject>, CsmNamedElement, CsmValidable


Method Summary
 CsmClassifier findClassifier(String qualifiedName)
          Finds compound classifier (clas or enum) by its qualified name
 CsmDeclaration findDeclaration(String uniqueName)
          Finds declaration by its nuique name
 Collection<CsmOffsetableDeclaration> findDeclarations(String uniqueName)
          Finds declarations by its nuique name
 CsmFile findFile(String absolutePath)
          Finds file by its absolute path
 CsmNamespace findNamespace(String qualifiedName)
          Finds namespace by its qualified name TODO: what if different projects contain namespaces with equal FQN? Now we assume that these namespaces are represented via different instances.
 Collection<CsmFile> getAllFiles()
          Gets the collection of all (source and heaher) project files.
 CsmNamespace getGlobalNamespace()
           
 Collection<CsmFile> getHeaderFiles()
          Gets the collection of heaher project files.
 Collection<CsmProject> getLibraries()
          Gets the collection of libraries of the project.
 Object getPlatformProject()
          Gets an object, which represents correspondent IDE project
 Collection<CsmFile> getSourceFiles()
          Gets the collection of source project files.
 boolean isArtificial()
          return true for auto created projects for included standard headers.
 boolean isStable(CsmFile skipFile)
          Returns true if the project is completely parsed
 void waitParse()
           
 
Methods inherited from interface org.netbeans.modules.cnd.api.model.CsmIdentifiable
getUID
 
Methods inherited from interface org.netbeans.modules.cnd.api.model.CsmNamedElement
getName
 
Methods inherited from interface org.netbeans.modules.cnd.api.model.CsmValidable
isValid
 

Method Detail

getGlobalNamespace

CsmNamespace getGlobalNamespace()

waitParse

void waitParse()

getPlatformProject

Object getPlatformProject()
Gets an object, which represents correspondent IDE project


findNamespace

CsmNamespace findNamespace(String qualifiedName)
Finds namespace by its qualified name TODO: what if different projects contain namespaces with equal FQN? Now we assume that these namespaces are represented via different instances. Probably this is not correct


findClassifier

CsmClassifier findClassifier(String qualifiedName)
Finds compound classifier (clas or enum) by its qualified name


findDeclaration

CsmDeclaration findDeclaration(String uniqueName)
Finds declaration by its nuique name


findDeclarations

Collection<CsmOffsetableDeclaration> findDeclarations(String uniqueName)
Finds declarations by its nuique name


findFile

CsmFile findFile(String absolutePath)
Finds file by its absolute path


getSourceFiles

Collection<CsmFile> getSourceFiles()
Gets the collection of source project files.


getHeaderFiles

Collection<CsmFile> getHeaderFiles()
Gets the collection of heaher project files.


getAllFiles

Collection<CsmFile> getAllFiles()
Gets the collection of all (source and heaher) project files.


getLibraries

Collection<CsmProject> getLibraries()
Gets the collection of libraries of the project. Library can be either other project (which this project depends on) or just a set of system include files (most likely, the latter kind of project would correspond with one include directory, so there would be as many libraries as include path components)


isStable

boolean isStable(CsmFile skipFile)
Returns true if the project is completely parsed

Parameters:
skipFile - if null => all project files are checked; if param is not null => project is stable even if skipFile not parsed

isArtificial

boolean isArtificial()
return true for auto created projects for included standard headers.


org.netbeans.modules.cnd.api.model/1 1.3 1

Built on November 23 2007.  |  Portions Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.

Project Features

About this Project

CND was started in November 2009, is owned by DimaZh, and has 192 members.
By use of this website, you agree to the NetBeans Policies and Terms of Use (revision 20160708.bf2ac18). © 2014, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo
 
 
Close
loading
Please Confirm
Close