Class ModuleSetAssemblyPhase

java.lang.Object

org.apache.maven.plugins.assembly.archive.phase.ModuleSetAssemblyPhase

All Implemented Interfaces:

AssemblyArchiverPhase, PhaseOrder

@Singleton
@Named("module-sets")
public class ModuleSetAssemblyPhase
extends Object
implements AssemblyArchiverPhase, PhaseOrder

Handles the <moduleSets/> top-level section of the assembly descriptor.

Field Summary

Fields

Modifier and Type	Field	Description
private final DependencyResolver	dependencyResolver
private static final String	LINE_SEPARATOR	The line separator.
private static final org.slf4j.Logger	LOGGER
private final org.apache.maven.project.ProjectBuilder	projectBuilder

Constructor Summary

Constructors

Constructor	Description
ModuleSetAssemblyPhase(org.apache.maven.project.ProjectBuilder projectBuilder, DependencyResolver dependencyResolver)	Injected ctor.

Method Summary

Modifier and Type	Method	Description
(package private) void	addModuleArtifact(org.apache.maven.artifact.Artifact artifact, org.apache.maven.project.MavenProject project, org.codehaus.plexus.archiver.Archiver archiver, AssemblerConfigurationSource configSource, ModuleBinaries binaries)
(package private) void	addModuleBinaries(Assembly assembly, ModuleSet moduleSet, ModuleBinaries binaries, Set<org.apache.maven.project.MavenProject> projects, org.codehaus.plexus.archiver.Archiver archiver, AssemblerConfigurationSource configSource)
(package private) void	addModuleSourceFileSets(ModuleSources sources, Set<org.apache.maven.project.MavenProject> moduleProjects, org.codehaus.plexus.archiver.Archiver archiver, AssemblerConfigurationSource configSource)
(package private) FileSet	createFileSet(FileSet fileSet, ModuleSources sources, org.apache.maven.project.MavenProject moduleProject, AssemblerConfigurationSource configSource)
void	execute(Assembly assembly, org.codehaus.plexus.archiver.Archiver archiver, AssemblerConfigurationSource configSource)	Handle the associated section of the assembly descriptor.
static List<DependencySet>	getDependencySets(ModuleBinaries binaries)
static Set<org.apache.maven.project.MavenProject>	getModuleProjects(ModuleSet moduleSet, AssemblerConfigurationSource configSource, org.slf4j.Logger logger)
(package private) boolean	isDeprecatedModuleSourcesConfigPresent(ModuleSources sources)	Determine whether the deprecated file-set configuration directly within the ModuleSources object is present.
int	order()
private void	validate(ModuleSet moduleSet, AssemblerConfigurationSource configSource)
private List<org.apache.maven.project.MavenProject>	validateModuleVersions(Set<org.apache.maven.project.MavenProject> moduleProjects)

Methods inherited from class Object

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

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

LINE_SEPARATOR

private static final String LINE_SEPARATOR

The line separator.

projectBuilder

private final org.apache.maven.project.ProjectBuilder projectBuilder

dependencyResolver

private final DependencyResolver dependencyResolver

Constructor Details

ModuleSetAssemblyPhase

@Inject
public ModuleSetAssemblyPhase(org.apache.maven.project.ProjectBuilder projectBuilder,
 DependencyResolver dependencyResolver)

Injected ctor.

Method Details

getDependencySets

public static List<DependencySet> getDependencySets(ModuleBinaries binaries)

getModuleProjects

public static Set<org.apache.maven.project.MavenProject> getModuleProjects(ModuleSet moduleSet,
 AssemblerConfigurationSource configSource,
 org.slf4j.Logger logger)
                                                                    throws ArchiveCreationException

Throws:

ArchiveCreationException

execute

public void execute(Assembly assembly,
 org.codehaus.plexus.archiver.Archiver archiver,
 AssemblerConfigurationSource configSource)
             throws ArchiveCreationException,
AssemblyFormattingException,
InvalidAssemblerConfigurationException,
DependencyResolutionException

Handle the associated section of the assembly descriptor.

Specified by:

execute in interface AssemblyArchiverPhase

Parameters:

assembly - The assembly descriptor to use

archiver - The archiver used to create the assembly archive, to which files/directories/artifacts are added

configSource - The configuration for this assembly build, normally derived from the plugin that launched the assembly process.

Throws:

ArchiveCreationException - in case of an archive creation error.

AssemblyFormattingException - in case of a assembly formatting exception.

InvalidAssemblerConfigurationException - in case of an invalid assembler configuration.

DependencyResolutionException

validate

private void validate(ModuleSet moduleSet,
 AssemblerConfigurationSource configSource)

addModuleBinaries

void addModuleBinaries(Assembly assembly,
 ModuleSet moduleSet,
 ModuleBinaries binaries,
 Set<org.apache.maven.project.MavenProject> projects,
 org.codehaus.plexus.archiver.Archiver archiver,
 AssemblerConfigurationSource configSource)
                throws ArchiveCreationException,
AssemblyFormattingException,
InvalidAssemblerConfigurationException,
DependencyResolutionException

Throws:

ArchiveCreationException

AssemblyFormattingException

InvalidAssemblerConfigurationException

DependencyResolutionException

validateModuleVersions

private List<org.apache.maven.project.MavenProject> validateModuleVersions(Set<org.apache.maven.project.MavenProject> moduleProjects)

addModuleArtifact

void addModuleArtifact(org.apache.maven.artifact.Artifact artifact,
 org.apache.maven.project.MavenProject project,
 org.codehaus.plexus.archiver.Archiver archiver,
 AssemblerConfigurationSource configSource,
 ModuleBinaries binaries)
                throws ArchiveCreationException,
AssemblyFormattingException

Throws:

ArchiveCreationException

AssemblyFormattingException

addModuleSourceFileSets

void addModuleSourceFileSets(ModuleSources sources,
 Set<org.apache.maven.project.MavenProject> moduleProjects,
 org.codehaus.plexus.archiver.Archiver archiver,
 AssemblerConfigurationSource configSource)
                      throws ArchiveCreationException,
AssemblyFormattingException

Throws:

ArchiveCreationException

AssemblyFormattingException

isDeprecatedModuleSourcesConfigPresent

boolean isDeprecatedModuleSourcesConfigPresent(ModuleSources sources)

Determine whether the deprecated file-set configuration directly within the ModuleSources object is present.

createFileSet

FileSet createFileSet(FileSet fileSet,
 ModuleSources sources,
 org.apache.maven.project.MavenProject moduleProject,
 AssemblerConfigurationSource configSource)
               throws AssemblyFormattingException

Throws:

AssemblyFormattingException

order

public int order()

Specified by:

order in interface PhaseOrder