AbstractSourceJarMojo (Maven Source Plugin 2.0.4 API)

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.maven.plugin.source
Class AbstractSourceJarMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.plugin.source.AbstractSourceJarMojo

All Implemented Interfaces:: org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:: SourceJarMojo, TestSourceJarMojo

public abstract class AbstractSourceJarMojo
extends org.apache.maven.plugin.AbstractMojo

Base class for bundling sources into a jar archive.

Version:: $Id: AbstractSourceJarMojo.java 592826 2007-11-07 17:46:46Z dennisl $

Field Summary
`protected boolean`	`excludeResources` Specifies whether or not to exclude resources from the sources-jar.
`protected java.lang.String`	`finalName` The filename to be used for the generated archive file.
`protected java.io.File`	`outputDirectory` The directory where the generated archive file will be put.
`protected org.apache.maven.project.MavenProject`	`project`
`protected java.util.List`	`reactorProjects` Contains the full list of projects in the reactor.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary
`AbstractSourceJarMojo()`

Method Summary
`protected void`	`addDirectory(org.codehaus.plexus.archiver.Archiver archiver, java.io.File sourceDirectory, java.lang.String[] includes, java.lang.String[] excludes)`
`protected void`	`addDirectory(org.codehaus.plexus.archiver.Archiver archiver, java.io.File sourceDirectory, java.lang.String prefix, java.lang.String[] includes, java.lang.String[] excludes)`
`protected void`	`archiveProjectContent(org.apache.maven.project.MavenProject project, org.codehaus.plexus.archiver.Archiver archiver)`
`protected void`	`attachArtifact(java.io.File outputFile, java.lang.String classifier)` Method to attach generated artifact to artifact list
`protected org.codehaus.plexus.archiver.Archiver`	`createArchiver()`
`void`	`execute()`
`protected abstract java.lang.String`	`getClassifier()`
`protected org.apache.maven.project.MavenProject`	`getProject(org.apache.maven.project.MavenProject project)`
`protected abstract java.util.List`	`getResources(org.apache.maven.project.MavenProject project)`
`protected abstract java.util.List`	`getSources(org.apache.maven.project.MavenProject project)`
`protected void`	`packageSources(java.util.List projects)`
`protected void`	`packageSources(org.apache.maven.project.MavenProject project)`

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

project

protected org.apache.maven.project.MavenProject project

excludeResources

protected boolean excludeResources

Specifies whether or not to exclude resources from the sources-jar. This can be convenient if your project includes large resources, such as images, and you don't want to include them in the sources-jar.

Since:: 2.0.4

outputDirectory

protected java.io.File outputDirectory

The directory where the generated archive file will be put. Defaults to ${project.build.directory} specified in the pom or inherited from the super pom.

finalName

protected java.lang.String finalName

The filename to be used for the generated archive file. For the source:jar goal, "-sources" is appended to this filename. For the source:test-jar goal, "-test-sources" is appended. Defaults to ${project.build.finalName} specified in the pom or inherited from the super pom.

reactorProjects

protected java.util.List reactorProjects

Contains the full list of projects in the reactor.

Constructor Detail