|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Library
The Library interface is the application root for module management.
Field Summary | |
---|---|
static String |
INDEX_FILENAME
Index filename. |
Method Summary | |
---|---|
Module[] |
getAllModules()
Return a array of all modules in the library. |
Module |
getModule(String ref)
Return a named module. |
Module[] |
getModules()
Return a array of the top-level modules within the library. |
Resource |
getResource(String ref)
Recursively lookup a resource using a fully qualified reference. |
Resource |
locate(File base)
Locate a resource relative to a base directory. |
Resource[] |
select(File base)
Select all local projects with a basedir equal to or depper than the supplied directory. |
Resource[] |
select(File base,
boolean self)
Select all local projects relative to the supplied basedir. |
Resource[] |
select(String criteria,
boolean sort)
Select a set of resource matching a supplied a resource selection constraint. |
Resource[] |
select(String criteria,
boolean local,
boolean sort)
Select a set of resource matching a supplied a resource selection constraint. |
Resource[] |
sort(Resource[] resources)
Utility operation to sort a collection of resources. |
Field Detail |
---|
static final String INDEX_FILENAME
Method Detail |
---|
Resource[] sort(Resource[] resources)
resources
- the resources to sort
Module[] getModules()
Module[] getAllModules()
Module getModule(String ref) throws ModuleNotFoundException
ref
- the fully qualified module name
ModuleNotFoundException
- if the module cannot be foundResource getResource(String ref) throws ResourceNotFoundException
ref
- the fully qualified resource name
ResourceNotFoundException
- if the resource cannot be foundResource[] select(String criteria, boolean sort)
Select a set of resource matching a supplied a resource selection constraint. The constraint may contain the wildcards '**' and '*'.
criteria
- the selection criteriasort
- if true the returned array will be sorted relative to dependencies
otherwise the array will be sorted alphanumerically with respect to the resource
path
Resource[] select(String criteria, boolean local, boolean sort)
Select a set of resource matching a supplied a resource selection constraint. The constraint may contain the wildcards '**' and '*'.
local
- if true limit the selection to local projectscriteria
- the selection criteriasort
- if true the returned array will be sorted relative to dependencies
otherwise the array will be sorted alphanumerically with respect to the resource
path
Resource[] select(File base)
base
- the reference basedir
Resource[] select(File base, boolean self)
base
- the reference basedirself
- if true and the basedir resolves to a project then include the project
otherwise the project will be expluded from selection
Resource locate(File base) throws ResourceNotFoundException
base
- the base directory
ResourceNotFoundException
- if resource match relative to the supplied base
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |