org.apache.maven.plugin.dependency.fromConfiguration
Class UnpackMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.plugin.dependency.AbstractDependencyMojo
          org.apache.maven.plugin.dependency.fromConfiguration.AbstractFromConfigurationMojo
              org.apache.maven.plugin.dependency.fromConfiguration.UnpackMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public final class UnpackMojo
extends AbstractFromConfigurationMojo

Goal that retrieves a list of artifacts from the repository and unpacks them in a defined location.

Since:

1.0

Version:

$Id: UnpackMojo.java 1085975 2011-03-27 16:03:41Z hboutemy $

Author:

Brian Fox

Is defined by the goal name:

unpack

Is bound to the specified phase of the standard build lifecycle:

process-sources

Field Summary

Fields inherited from class org.apache.maven.plugin.dependency.fromConfiguration.AbstractFromConfigurationMojo

reactorProjects

Fields inherited from class org.apache.maven.plugin.dependency.AbstractDependencyMojo

archiverManager, artifactCollector, artifactMetadataSource, factory, outputAbsoluteArtifactFilename, project, remoteRepos, resolver, silent

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

ROLE

Constructor Summary

UnpackMojo()

Method Summary

void	execute() Main entry into mojo.
String	getExcludes()
String	getIncludes()
File	getMarkersDirectory()
protected List<ArtifactItem>	getProcessedArtifactItems(boolean removeVersion) Preprocesses the list of ArtifactItems.
void	setExcludes(String excludes)
void	setIncludes(String includes)
void	setMarkersDirectory(File theMarkersDirectory)

Methods inherited from class org.apache.maven.plugin.dependency.fromConfiguration.AbstractFromConfigurationMojo

getArtifact, getArtifactItems, getLocal, getOutputDirectory, isOverWriteIfNewer, isOverWriteReleases, isOverWriteSnapshots, isSkip, setArtifactItems, setLocalRepositoryDirectory, setOutputDirectory, setOverWriteIfNewer, setOverWriteReleases, setOverWriteSnapshots, setSkip

Methods inherited from class org.apache.maven.plugin.dependency.AbstractDependencyMojo

copyFile, getArchiverManager, getArtifactCollector, getArtifactMetadataSource, getFactory, getLog, getProject, getRemoteRepos, getResolver, setArchiverManager, setArtifactCollector, setArtifactMetadataSource, setFactory, setLocal, setRemoteRepos, setResolver, unpack, unpack

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

getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Constructor Detail

UnpackMojo

public UnpackMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Main entry into mojo. This method gets the ArtifactItems and iterates through each one passing it to unpackArtifact.

Throws:

org.apache.maven.plugin.MojoExecutionException - with a message if an error occurs.

See Also:

ArtifactItem, AbstractFromConfigurationMojo.getArtifactItems(), unpackArtifact(ArtifactItem)

getProcessedArtifactItems

protected List<ArtifactItem> getProcessedArtifactItems(boolean removeVersion)
                                                throws org.apache.maven.plugin.MojoExecutionException

Description copied from class: AbstractFromConfigurationMojo

Preprocesses the list of ArtifactItems. This method defaults the outputDirectory if not set and creates the output Directory if it doesn't exist.

Overrides:

getProcessedArtifactItems in class AbstractFromConfigurationMojo

Parameters:

removeVersion - remove the version from the filename.

Returns:

An ArrayList of preprocessed ArtifactItems

Throws:

org.apache.maven.plugin.MojoExecutionException - with a message if an error occurs.

See Also:

ArtifactItem

getMarkersDirectory

public File getMarkersDirectory()

Returns:

Returns the markersDirectory.

setMarkersDirectory

public void setMarkersDirectory(File theMarkersDirectory)

Parameters:

theMarkersDirectory - The markersDirectory to set.

getExcludes

public String getExcludes()

Returns:

Returns a comma separated list of excluded items

setExcludes

public void setExcludes(String excludes)

Parameters:

excludes - A comma separated list of items to exclude i.e. **\/*.xml, **\/*.properties

getIncludes

public String getIncludes()

Returns:

Returns a comma separated list of included items

setIncludes

public void setIncludes(String includes)

Parameters:

includes - A comma separated list of items to include i.e. **\/*.xml, **\/*.properties