|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Context
Project context.
Method Summary | |
---|---|
File |
createFile(String path)
Create a file relative to the resource basedir. |
Path |
createPath(Resource[] resources)
Utility operation to construct a new path using a supplied array of resources. |
Path |
createPath(Resource[] resources,
boolean resolve,
boolean filter)
Utility operation to construct a new path using a supplied array of resources. |
Path |
createPath(Scope scope)
Utility operation to construct a new classpath path instance. |
File |
getEtcDataDirectory()
Return the project etc/data directory. |
File |
getEtcDirectory()
Return the project etc directory. |
File |
getEtcMainDirectory()
Return the project etc/main directory. |
File |
getEtcTestDirectory()
Return the project etc/test directory. |
String |
getLayoutBase(String id)
Return the directory path representing the module structure and type using the layout strategy employed by the cache. |
String |
getLayoutFilename(String id)
Return a filename using the layout strategy employed by the cache. |
String |
getLayoutPath(String id)
Return the full path to an artifact using the layout employed by the cache. |
Library |
getLibrary()
Return the resource library. |
Path |
getPath(Scope scope)
Return an Ant path suitable for compile or runtime usage. |
Project |
getProject()
Return the associated project. |
String |
getProperty(String key)
Return the value of a property. |
String |
getProperty(String key,
String value)
Return the value of a property. |
Resource |
getResource()
Return the active resource. |
File |
getSrcDirectory()
Return the project source directory. |
File |
getSrcDocsDirectory()
Return the project source docs directory. |
File |
getSrcMainDirectory()
Return the project source main directory. |
File |
getSrcTestDirectory()
Return the project source test directory. |
File |
getTargetBuildDirectory()
Return the project target build directory. |
File |
getTargetBuildDocsDirectory()
Return the project target build docs directory. |
File |
getTargetBuildMainDirectory()
Return the project target build main directory. |
File |
getTargetBuildTestDirectory()
Return the project target build test directory. |
File |
getTargetClassesDirectory()
Return the project target root classes directory. |
File |
getTargetClassesMainDirectory()
Return the project target main classes directory. |
File |
getTargetClassesTestDirectory()
Return the project target test classes directory. |
File |
getTargetDeliverable(String type)
Return the project target deliverables directory. |
File |
getTargetDeliverablesDirectory()
Return the project target deliverables directory. |
File |
getTargetDirectory()
Return the project target directory. |
File |
getTargetDirectory(String path)
Return a directory within the target directory. |
File |
getTargetDocsDirectory()
Return the project target reports docs directory. |
File |
getTargetReportsDirectory()
Return the project target reports directory. |
File |
getTargetReportsJavadocDirectory()
Return the project target javadoc reports directory. |
File |
getTargetReportsMainDirectory()
Return the project target main reports directory. |
File |
getTargetReportsTestDirectory()
Return the project target test reports directory. |
File |
getTargetTempDirectory()
Return the project target temp directory. |
File |
getTargetTestDirectory()
Return the project target test directory. |
void |
init()
Initialize the context. |
Method Detail |
---|
Project getProject()
String getProperty(String key)
key
- the property key
String getProperty(String key, String value)
key
- the property keyvalue
- the default value
void init()
Path getPath(Scope scope)
scope
- the build scope
Resource getResource()
Library getLibrary()
File getSrcDirectory()
File getSrcMainDirectory()
File getSrcTestDirectory()
File getSrcDocsDirectory()
File getEtcDirectory()
File getEtcMainDirectory()
File getEtcTestDirectory()
File getEtcDataDirectory()
File getTargetDirectory()
File getTargetDirectory(String path)
path
- the path
File getTargetTempDirectory()
File getTargetBuildDirectory()
File getTargetBuildMainDirectory()
File getTargetBuildTestDirectory()
File getTargetBuildDocsDirectory()
File getTargetClassesDirectory()
File getTargetClassesMainDirectory()
File getTargetClassesTestDirectory()
File getTargetReportsDirectory()
File getTargetReportsTestDirectory()
File getTargetReportsMainDirectory()
File getTargetReportsJavadocDirectory()
File getTargetDocsDirectory()
File getTargetTestDirectory()
File getTargetDeliverablesDirectory()
File getTargetDeliverable(String type)
type
- the deliverable type
File createFile(String path)
path
- the relative path
String getLayoutFilename(String id)
id
- the artifact type
String getLayoutBase(String id)
id
- the artifact type
String getLayoutPath(String id)
id
- the artifact type
Path createPath(Scope scope)
scope
- the build scope
Path createPath(Resource[] resources)
resources
- the resource to use in path construction
Path createPath(Resource[] resources, boolean resolve, boolean filter)
resources
- the resources to use in path constructionresolve
- if true force local caching of the artifactfilter
- if true restrict path entries to resources that produce jars
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |