UnpackMojo (Maven Dependency Plugin 2.8 API)

Overview

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.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:: ContextEnabled, Mojo

@Mojo(name="unpack", defaultPhase=PROCESS_SOURCES, requiresProject=false, threadSafe=true) public class UnpackMojo
extends AbstractFromConfigurationMojo
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.html 861760 2013-05-12 17:31:26Z hboutemy $
Author:: Brian Fox

Field Summary

Fields inherited from class org.apache.maven.plugin.dependency.AbstractDependencyMojo
`archiverManager, artifactCollector, artifactMetadataSource, factory, ignorePermissions, outputAbsoluteArtifactFilename, project, reactorProjects, remoteRepos, resolver, silent, useJvmChmod`

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

Constructor Summary
`UnpackMojo()`

Method Summary
`protected void`	`doExecute()` Main entry into mojo.
`String`	`getExcludes()`
`String`	`getIncludes()`
`File`	`getMarkersDirectory()`
`protected List<ArtifactItem>`	`getProcessedArtifactItems(boolean removeVersion)`
`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, getProcessedArtifactItems, isOverWriteIfNewer, isOverWriteReleases, isOverWriteSnapshots, setArtifact, setArtifactItems, setLocalRepositoryDirectory, setOutputDirectory, setOverWriteIfNewer, setOverWriteReleases, setOverWriteSnapshots, verifyRequirements`

Methods inherited from class org.apache.maven.plugin.dependency.AbstractDependencyMojo
`copyFile, execute, getArchiverManager, getArtifactCollector, getArtifactMetadataSource, getFactory, getLog, getProject, getRemoteRepos, getResolver, isSkip, isUseJvmChmod, setArchiverManager, setArtifactCollector, setArtifactMetadataSource, setFactory, setLocal, setRemoteRepos, setResolver, setSkip, setUseJvmChmod, 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

doExecute

protected void doExecute()
                  throws MojoExecutionException,
                         MojoFailureException

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

Specified by:: doExecute in class AbstractDependencyMojo

Throws:: MojoExecutionException - with a message if an error occurs.; MojoFailureException
See Also:: ArtifactItem, AbstractFromConfigurationMojo.getArtifactItems(), unpackArtifact(ArtifactItem)

getProcessedArtifactItems

protected List<ArtifactItem> getProcessedArtifactItems(boolean removeVersion)
                                                throws MojoExecutionException

Throws:: MojoExecutionException

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