You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by kh...@apache.org on 2014/10/19 02:19:24 UTC
svn commit: r1632869 - in
/maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly:
./ archive/ archive/phase/ archive/phase/wrappers/
Author: khmarbaise
Date: Sun Oct 19 00:19:23 2014
New Revision: 1632869
URL: http://svn.apache.org/r1632869
Log:
[MASSEMBLY-720]
- Followup furhter cleanup of checkstyle reported issues.
Modified:
maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/InvalidAssemblerConfigurationException.java
maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/ArchiveCreationException.java
maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/ArchiveExpansionException.java
maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/AssemblyArchiver.java
maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/DefaultAssemblyArchiver.java
maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/AssemblyArchiverPhase.java
maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/ModuleSetAssemblyPhase.java
maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/wrappers/GroupVersionAlignmentWrapper.java
maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/wrappers/RepoInfoWrapper.java
Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/InvalidAssemblerConfigurationException.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/InvalidAssemblerConfigurationException.java?rev=1632869&r1=1632868&r2=1632869&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/InvalidAssemblerConfigurationException.java (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/InvalidAssemblerConfigurationException.java Sun Oct 19 00:19:23 2014
@@ -28,11 +28,18 @@ public class InvalidAssemblerConfigurati
private static final long serialVersionUID = 1L;
+ /**
+ * @param message The message.
+ * @param error The error
+ */
public InvalidAssemblerConfigurationException( final String message, final Throwable error )
{
super( message, error );
}
+ /**
+ * @param message The message.
+ */
public InvalidAssemblerConfigurationException( final String message )
{
super( message );
Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/ArchiveCreationException.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/ArchiveCreationException.java?rev=1632869&r1=1632868&r2=1632869&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/ArchiveCreationException.java (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/ArchiveCreationException.java Sun Oct 19 00:19:23 2014
@@ -28,11 +28,19 @@ public class ArchiveCreationException
private static final long serialVersionUID = 1L;
+ /**
+ * Create in instance.
+ * @param message The message to use.
+ * @param error The error.
+ */
public ArchiveCreationException( final String message, final Throwable error )
{
super( message, error );
}
+ /**
+ * @param message The message.
+ */
public ArchiveCreationException( final String message )
{
super( message );
Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/ArchiveExpansionException.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/ArchiveExpansionException.java?rev=1632869&r1=1632868&r2=1632869&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/ArchiveExpansionException.java (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/ArchiveExpansionException.java Sun Oct 19 00:19:23 2014
@@ -28,11 +28,18 @@ public class ArchiveExpansionException
private static final long serialVersionUID = 1L;
+ /**
+ * @param message The message to use for this instance.
+ * @param error The error which has been thrown.
+ */
public ArchiveExpansionException( final String message, final Throwable error )
{
super( message, error );
}
+ /**
+ * @param message The message.
+ */
public ArchiveExpansionException( final String message )
{
super( message );
Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/AssemblyArchiver.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/AssemblyArchiver.java?rev=1632869&r1=1632868&r2=1632869&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/AssemblyArchiver.java (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/AssemblyArchiver.java Sun Oct 19 00:19:23 2014
@@ -33,6 +33,28 @@ public interface AssemblyArchiver
{
String ROLE = AssemblyArchiver.class.getName();
+ /**
+ * Create the assembly archive. Generally:
+ * <ol>
+ * <li>Setup any directory structures for temporary files</li>
+ * <li>Calculate the output directory/file for the assembly</li>
+ * <li>Setup any handler components for special descriptor files we may encounter</li>
+ * <li>Lookup and configure the {@link Archiver} to be used</li>
+ * <li>Determine what, if any, dependency resolution will be required, and resolve any dependency-version conflicts
+ * up front to produce a managed-version map for the whole assembly process.</li>
+ * <li>Iterate through the available {@link AssemblyArchiverPhase} instances, executing each to handle a different
+ * top-level section of the assembly descriptor, if that section is present.</li>
+ * </ol>
+ * @param assembly The {@link Assembly}
+ * @param fullName The full name.
+ * @param format The format.
+ * @param configSource The {@link AssemblerConfigurationSource}
+ * @param recompressZippedFiles recompress zipped files.
+ * @return The resulting archive file.
+ * @throws ArchiveCreationException
+ * @throws AssemblyFormattingException
+ * @throws InvalidAssemblerConfigurationException
+ */
File createArchive( Assembly assembly, String fullName, String format, AssemblerConfigurationSource configSource,
boolean recompressZippedFiles )
throws ArchiveCreationException, AssemblyFormattingException, InvalidAssemblerConfigurationException;
Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/DefaultAssemblyArchiver.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/DefaultAssemblyArchiver.java?rev=1632869&r1=1632868&r2=1632869&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/DefaultAssemblyArchiver.java (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/DefaultAssemblyArchiver.java Sun Oct 19 00:19:23 2014
@@ -107,12 +107,20 @@ public class DefaultAssemblyArchiver
private PlexusContainer container;
+ /**
+ * create instance.
+ */
public DefaultAssemblyArchiver()
{
// needed for plexus
}
// introduced for testing.
+ /**
+ * @param archiverManager The archive manager.
+ * @param resolver The {@link DependencyResolver}.
+ * @param assemblyPhases The list of {@link AssemblyArchiverPhase}
+ */
protected DefaultAssemblyArchiver( final ArchiverManager archiverManager, final DependencyResolver resolver,
final List<AssemblyArchiverPhase> assemblyPhases )
{
@@ -121,19 +129,7 @@ public class DefaultAssemblyArchiver
this.assemblyPhases = assemblyPhases;
}
- /**
- * Create the assembly archive. Generally:
- * <ol>
- * <li>Setup any directory structures for temporary files</li>
- * <li>Calculate the output directory/file for the assembly</li>
- * <li>Setup any handler components for special descriptor files we may encounter</li>
- * <li>Lookup and configure the {@link Archiver} to be used</li>
- * <li>Determine what, if any, dependency resolution will be required, and resolve any dependency-version conflicts
- * up front to produce a managed-version map for the whole assembly process.</li>
- * <li>Iterate through the available {@link AssemblyArchiverPhase} instances, executing each to handle a different
- * top-level section of the assembly descriptor, if that section is present.</li>
- * </ol>
- */
+ /** {@inheritDoc} */
public File createArchive( final Assembly assembly, final String fullName, final String format,
final AssemblerConfigurationSource configSource, boolean recompressZippedFiles )
throws ArchiveCreationException, AssemblyFormattingException, InvalidAssemblerConfigurationException
@@ -186,8 +182,10 @@ public class DefaultAssemblyArchiver
// own artifact resolution.
final Set<Artifact> dependencySetArtifacts = dependencyResolver.resolve( assembly, configSource );
+ // CHECKSTYLE_OFF: LineLength
final ResolvedAssembly resolvedAssembly =
ResolvedAssembly.create( assembly ).withResolvedModuleSets( resolvedModuleSets ).withDependencySetArtifacts( dependencySetArtifacts );
+ // CHECKSTYLE_ON: LineLength
for ( AssemblyArchiverPhase phase : assemblyPhases )
{
@@ -229,9 +227,11 @@ public class DefaultAssemblyArchiver
}
}
+ // CHECKSTYLE_OFF: LineLength
private List<ContainerDescriptorHandler> selectContainerDescriptorHandlers( List<ContainerDescriptorHandlerConfig> requestedContainerDescriptorHandlers,
final AssemblerConfigurationSource configSource )
throws InvalidAssemblerConfigurationException
+ // CHECKSTYLE_ON: LineLength
{
getLogger().debug( "All known ContainerDescriptorHandler components: "
+ ( containerDescriptorHandlers == null ? "none; map is null." : ""
@@ -286,11 +286,11 @@ public class DefaultAssemblyArchiver
* Creates the necessary archiver to build the distribution file.
*
* @param format Archive format
- * @param includeBaseDir
- * @param finalName
- * @param configSource
- * @param containerHandlers
- * @param recompressZippedFiles
+ * @param includeBaseDir the base directory for include.
+ * @param finalName The final name.
+ * @param configSource {@link AssemblerConfigurationSource}
+ * @param containerHandlers The list of {@link ContainerDescriptorHandler}
+ * @param recompressZippedFiles recompress zipped files.
* @return archiver Archiver generated
* @throws org.codehaus.plexus.archiver.ArchiverException
* @throws org.codehaus.plexus.archiver.manager.NoSuchArchiverException
Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/AssemblyArchiverPhase.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/AssemblyArchiverPhase.java?rev=1632869&r1=1632868&r2=1632869&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/AssemblyArchiverPhase.java (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/AssemblyArchiverPhase.java Sun Oct 19 00:19:23 2014
@@ -43,9 +43,9 @@ public interface AssemblyArchiverPhase
* @param archiver The archiver used to create the assembly archive, to which files/directories/artifacts are added
* @param configSource The configuration for this assembly build, normally derived from the plugin that launched the
* assembly process.
- * @throws ArchiveCreationException
- * @throws AssemblyFormattingException
- * @throws InvalidAssemblerConfigurationException
+ * @throws ArchiveCreationException in case of an archive creation error.
+ * @throws AssemblyFormattingException in case of a assembly formatting exception.
+ * @throws InvalidAssemblerConfigurationException in case of an invalid assembler configuration.
*/
void execute( ResolvedAssembly assembly, Archiver archiver, AssemblerConfigurationSource configSource )
throws ArchiveCreationException, AssemblyFormattingException, InvalidAssemblerConfigurationException;
Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/ModuleSetAssemblyPhase.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/ModuleSetAssemblyPhase.java?rev=1632869&r1=1632868&r2=1632869&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/ModuleSetAssemblyPhase.java (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/ModuleSetAssemblyPhase.java Sun Oct 19 00:19:23 2014
@@ -74,6 +74,9 @@ public class ModuleSetAssemblyPhase
{
// TODO: Remove if using something like commons-lang instead.
+ /**
+ * The line separator.
+ */
public static final String LINE_SEPARATOR = System.getProperty( "line.separator" );
@Requirement
@@ -82,11 +85,18 @@ public class ModuleSetAssemblyPhase
@Requirement
private ArchiverManager archiverManager;
+ /**
+ * Create an instance.
+ */
public ModuleSetAssemblyPhase()
{
// needed for plexus
}
+ /**
+ * @param projectBuilder The project builder.
+ * @param logger The logger.
+ */
public ModuleSetAssemblyPhase( final MavenProjectBuilder projectBuilder, final Logger logger )
{
this.projectBuilder = projectBuilder;
@@ -463,7 +473,8 @@ public class ModuleSetAssemblyPhase
return result;
}
- protected @Nonnull FileSet createFileSet( @Nonnull
+ @Nonnull
+ protected FileSet createFileSet( @Nonnull
final FileSet fileSet, @Nonnull
final ModuleSources sources, @Nonnull
final MavenProject moduleProject, @Nonnull
@@ -555,9 +566,10 @@ public class ModuleSetAssemblyPhase
return fs;
}
- public static @Nonnull Set<MavenProject> getModuleProjects( final ModuleSet moduleSet,
- final AssemblerConfigurationSource configSource,
- final Logger logger )
+ @Nonnull
+ public static Set<MavenProject> getModuleProjects( final ModuleSet moduleSet,
+ final AssemblerConfigurationSource configSource,
+ final Logger logger )
throws ArchiveCreationException
{
MavenProject project = configSource.getProject();
Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/wrappers/GroupVersionAlignmentWrapper.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/wrappers/GroupVersionAlignmentWrapper.java?rev=1632869&r1=1632868&r2=1632869&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/wrappers/GroupVersionAlignmentWrapper.java (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/wrappers/GroupVersionAlignmentWrapper.java Sun Oct 19 00:19:23 2014
@@ -32,21 +32,27 @@ public class GroupVersionAlignmentWrappe
private final GroupVersionAlignment alignment;
+ /**
+ * @param alignment @{link {@link GroupVersionAlignment}
+ */
public GroupVersionAlignmentWrapper( final GroupVersionAlignment alignment )
{
this.alignment = alignment;
}
+ /** {@inheritDoc} */
public List<String> getExcludes()
{
return alignment.getExcludes();
}
+ /** {@inheritDoc} */
public String getId()
{
return alignment.getId();
}
+ /** {@inheritDoc} */
public String getVersion()
{
return alignment.getVersion();
Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/wrappers/RepoInfoWrapper.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/wrappers/RepoInfoWrapper.java?rev=1632869&r1=1632868&r2=1632869&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/wrappers/RepoInfoWrapper.java (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/wrappers/RepoInfoWrapper.java Sun Oct 19 00:19:23 2014
@@ -37,16 +37,21 @@ public class RepoInfoWrapper
private List<GroupVersionAlignmentWrapper> convertedAlignments;
+ /**
+ * @param repo The {@link Repository}
+ */
public RepoInfoWrapper( final Repository repo )
{
this.repo = repo;
}
+ /** {@inheritDoc} */
public List<String> getExcludes()
{
return repo.getExcludes();
}
+ /** {@inheritDoc} */
public List<GroupVersionAlignmentWrapper> getGroupVersionAlignments()
{
final List<GroupVersionAlignment> alignments = repo.getGroupVersionAlignments();
@@ -67,16 +72,19 @@ public class RepoInfoWrapper
return convertedAlignments;
}
+ /** {@inheritDoc} */
public List<String> getIncludes()
{
return repo.getIncludes();
}
+ /** {@inheritDoc} */
public String getScope()
{
return repo.getScope();
}
+ /** {@inheritDoc} */
public boolean isIncludeMetadata()
{
return repo.isIncludeMetadata();