org.jboss.shrinkwrap.resolver.spi.maven.archive.packaging

Interface PackagingProcessor<ARCHIVETYPE extends org.jboss.shrinkwrap.api.Archive<ARCHIVETYPE>>

Type Parameters:

ARCHIVETYPE - Resulting archive type

public interface PackagingProcessor<ARCHIVETYPE extends org.jboss.shrinkwrap.api.Archive<ARCHIVETYPE>>

Packaging processor which is able to build an archive using data available in the Maven Working Session

Author:

Karel Piwko

Method Summary

Modifier and Type	Method and Description
PackagingProcessor<ARCHIVETYPE>	configure(org.jboss.shrinkwrap.api.Archive<?> originalArchive, MavenWorkingSession session) Configures packaging processor by passing Maven working session and original archive
ARCHIVETYPE	getResultingArchive() Returns archive as a ShrinkWrap archive
boolean	handles(PackagingType packagingType) Check that packagingType is supported by this packaging processor
PackagingProcessor<ARCHIVETYPE>	importBuildOutput(MavenResolutionStrategy strategy) Compiles, packages and resolve dependencies for the project.

Method Detail

handles

boolean handles(PackagingType packagingType)

Check that packagingType is supported by this packaging processor

Parameters:

packagingType - The packaging type to check.

Returns:

true if this processor handles the given packaging type, false otherwise.

configure

PackagingProcessor<ARCHIVETYPE> configure(org.jboss.shrinkwrap.api.Archive<?> originalArchive,
                                          MavenWorkingSession session)

Configures packaging processor by passing Maven working session and original archive

Parameters:

originalArchive - Original archive holder

session - Current Maven working session

Returns:

Modified instance for chaining

importBuildOutput

PackagingProcessor<ARCHIVETYPE> importBuildOutput(MavenResolutionStrategy strategy)
                                           throws IllegalArgumentException,
                                                  org.jboss.shrinkwrap.resolver.api.ResolutionException

Compiles, packages and resolve dependencies for the project. Uses strategy to define what dependencies will be packaged into project.

Parameters:

strategy - The strategy defining objects to be packaged

Returns:

The modified instance of the packaging processor for chaining.

Throws:

IllegalArgumentException - If strategy is null

org.jboss.shrinkwrap.resolver.api.ResolutionException - If a dependency of the project could not be resolved

getResultingArchive

ARCHIVETYPE getResultingArchive()

Returns archive as a ShrinkWrap archive

Returns:

The resulting archive.