Apache/maven
1
0
Fork 0
mirror of https://github.com/apache/maven.git synced 2025-02-20 17:05:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

improved documentation

Browse Source
This commit is contained in:
Hervé Boutemy 2018-08-12 00:01:17 +02:00
parent 396f49d75e
commit f5674713a6
3 changed files with 25 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
maven-artifact/src/main/java/org/apache/maven/artifact/handler/ArtifactHandler.java
View File

@ -20,16 +20,32 @@
*/
/**
* An artifact handler defies for one type (defined as Plexus role):<ul>
* <li>extension and classifier to be able to download the file,</li>
* <li>information on how to use the artifact: whether to add it to the classpath, or to take into account its
* dependencies.</li>
* </ul>
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
*/
public interface ArtifactHandler
{
String ROLE = ArtifactHandler.class.getName();
/**
* Get the file extension associated to the type of artifact.
*
* @return the extension
*/
String getExtension();
String getDirectory();
/**
* Get the classifier associated to the type of artifact.
*
* @return the classifier
*/
String getClassifier();
String getPackaging();

13
maven-core/src/site/apt/artifact-handlers.apt
View File

@ -25,7 +25,10 @@
Default Artifact Handlers Reference
Some artifact handlers (see {{{../maven-artifact/apidocs/org/apache/maven/artifact/handler/ArtifactHandler.html} API}})
Artifact handlers (see {{{../maven-artifact/apidocs/org/apache/maven/artifact/handler/ArtifactHandler.html} API}})
define for each {{{../maven-model/maven.html#class_dependency}dependency type}} information on the artifact.
Some artifact handlers
are configured by default in <<<META-INF/plexus/artifact-handlers.xml>>>:
*--------------------+------------+------------+---------------+-----------+---------------------+-----------------------+
@ -35,10 +38,14 @@ Default Artifact Handlers Reference
*--------------------+------------+------------+---------------+-----------+---------------------+-----------------------+
| <<<jar>>> | <= type> | <= type> | | java | <<<true>>> | |
*--------------------+------------+------------+---------------+-----------+---------------------+-----------------------+
| <<<test-jar>>> | <<<jar>>> | <<<jar>>> | <<<tests>>> | java | <<<true>>> | |
*--------------------+------------+------------+---------------+-----------+---------------------+-----------------------+
| <<<maven-plugin>>> | <<<jar>>> | <= type> | | java | <<<true>>> | |
*--------------------+------------+------------+---------------+-----------+---------------------+-----------------------+
| <<<ejb>>> | <<<jar>>> | <= type> | | java | <<<true>>> | |
*--------------------+------------+------------+---------------+-----------+---------------------+-----------------------+
| <<<ejb-client>>> | <<<jar>>> | <<<ejb>>> | <<<client>>> | java | <<<true>>> | |
*--------------------+------------+------------+---------------+-----------+---------------------+-----------------------+
| <<<war>>> | <= type> | <= type> | | java | | <<<true>>> |
*--------------------+------------+------------+---------------+-----------+---------------------+-----------------------+
| <<<ear>>> | <= type> | <= type> | | java | | <<<true>>> |
@ -49,7 +56,3 @@ Default Artifact Handlers Reference
*--------------------+------------+------------+---------------+-----------+---------------------+-----------------------+
| <<<javadoc>>> | <<<jar>>> | <= type> | <<<javadoc>>> | java | <<<true>>> | |
*--------------------+------------+------------+---------------+-----------+---------------------+-----------------------+
| <<<ejb-client>>> | <<<jar>>> | <<<ejb>>> | <<<client>>> | java | <<<true>>> | |
*--------------------+------------+------------+---------------+-----------+---------------------+-----------------------+
| <<<test-jar>>> | <<<jar>>> | <<<jar>>> | <<<tests>>> | java | <<<true>>> | |
*--------------------+------------+------------+---------------+-----------+---------------------+-----------------------+

2
maven-core/src/site/apt/index.apt
View File

@ -31,7 +31,7 @@ Maven Core
* {{{./lifecycles.html}lifecycles}} and {{{./default-bindings.html}plugin bindings to <<<default>>> lifecycle}},
* {{{./artifact-handlers.html}default artifact handlers}},
* {{{./artifact-handlers.html}default artifact handlers}}, to manage {{{../maven-model/maven.html#class_dependency}dependency types}},
* {{{./extension.html}extension descriptor}} and {{{./core-extensions.html}core extensions}},