You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by kr...@apache.org on 2014/10/27 09:12:17 UTC
svn commit: r1634469 - in
/maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly:
./ archive/ archive/archiver/ archive/phase/ format/ utils/
Author: krosenvold
Date: Mon Oct 27 08:12:16 2014
New Revision: 1634469
URL: http://svn.apache.org/r1634469
Log:
Fixed some checkstyle stuff
Modified:
maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/AssemblerConfigurationSource.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/archiver/AssemblyProxyArchiver.java
maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/FileItemAssemblyPhase.java
maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/format/ReaderFormatter.java
maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/utils/LineEndingsUtils.java
Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/AssemblerConfigurationSource.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/AssemblerConfigurationSource.java?rev=1634469&r1=1634468&r2=1634469&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/AssemblerConfigurationSource.java (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/AssemblerConfigurationSource.java Mon Oct 27 08:12:16 2014
@@ -182,6 +182,7 @@ public interface AssemblerConfigurationS
/**
* Maven shared filtering utility.
+ * @ return the maven reader filter
*/
MavenReaderFilter getMavenReaderFilter();
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=1634469&r1=1634468&r2=1634469&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 Mon Oct 27 08:12:16 2014
@@ -42,7 +42,8 @@ public interface AssemblyArchiver
* <li>Lookup and configure the {@link org.codehaus.plexus.archiver.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 org.apache.maven.plugin.assembly.archive.phase.AssemblyArchiverPhase} instances, executing each to handle a different
+ * <li>Iterate through the available {@link org.apache.maven.plugin.assembly.archive.phase.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}
@@ -51,9 +52,9 @@ public interface AssemblyArchiver
* @param configSource The {@link AssemblerConfigurationSource}
* @param recompressZippedFiles recompress zipped files.
* @return The resulting archive file.
- * @throws ArchiveCreationException
- * @throws AssemblyFormattingException
- * @throws InvalidAssemblerConfigurationException
+ * @throws ArchiveCreationException when creation fails
+ * @throws AssemblyFormattingException when formatting fails
+ * @throws InvalidAssemblerConfigurationException when the configurationis bad
*/
File createArchive( Assembly assembly, String fullName, String format, AssemblerConfigurationSource configSource,
boolean recompressZippedFiles )
Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/archiver/AssemblyProxyArchiver.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/archiver/AssemblyProxyArchiver.java?rev=1634469&r1=1634468&r2=1634469&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/archiver/AssemblyProxyArchiver.java (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/archiver/AssemblyProxyArchiver.java Mon Oct 27 08:12:16 2014
@@ -928,7 +928,7 @@ public class AssemblyProxyArchiver
private boolean acceptFile( final File inputFile )
throws ArchiverException
{
- if ( !Boolean.TRUE.equals( inPublicApi.get()) )
+ if ( !Boolean.TRUE.equals( inPublicApi.get() ) )
{
if ( selectors != null )
{
Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/FileItemAssemblyPhase.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/FileItemAssemblyPhase.java?rev=1634469&r1=1634468&r2=1634469&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/FileItemAssemblyPhase.java (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/archive/phase/FileItemAssemblyPhase.java Mon Oct 27 08:12:16 2014
@@ -37,7 +37,7 @@ import org.codehaus.plexus.logging.Abstr
/**
* Handles the top-level <files/> section of the assembly descriptor.
- *
+ *
* @version $Id$
*/
@Component( role = AssemblyArchiverPhase.class, hint = "file-items" )
@@ -73,9 +73,8 @@ public class FileItemAssemblyPhase
source = new File( basedir, sourcePath );
}
- source =
- fileFormatter.format( source, fileItem.isFiltered(), fileItem.getLineEnding(),
- configSource.getEncoding() );
+ source = fileFormatter.format( source, fileItem.isFiltered(), fileItem.getLineEnding(),
+ configSource.getEncoding() );
String destName = fileItem.getDestName();
@@ -106,7 +105,8 @@ public class FileItemAssemblyPhase
try
{
- archiver.addFile( source, target, TypeConversionUtils.modeToInt( fileItem.getFileMode(), getLogger() ) );
+ archiver.addFile( source, target,
+ TypeConversionUtils.modeToInt( fileItem.getFileMode(), getLogger() ) );
}
catch ( final ArchiverException e )
{
Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/format/ReaderFormatter.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/format/ReaderFormatter.java?rev=1634469&r1=1634468&r2=1634469&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/format/ReaderFormatter.java (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/format/ReaderFormatter.java Mon Oct 27 08:12:16 2014
@@ -105,7 +105,7 @@ public class ReaderFormatter
final String encoding = configSource.getEncoding();
Reader source = encoding != null ? new InputStreamReader( inputStream, encoding )
- : new InputStreamReader( inputStream ); // wtf platform encoding ?
+ : new InputStreamReader( inputStream ); // wtf platform encoding ? TODO: Fix this
try
{
Reader filtered = createReaderFilter( source, plexusIoResource.getName(),
Modified: maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/utils/LineEndingsUtils.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/utils/LineEndingsUtils.java?rev=1634469&r1=1634468&r2=1634469&view=diff
==============================================================================
--- maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/utils/LineEndingsUtils.java (original)
+++ maven/plugins/trunk/maven-assembly-plugin/src/main/java/org/apache/maven/plugin/assembly/utils/LineEndingsUtils.java Mon Oct 27 08:12:16 2014
@@ -54,10 +54,11 @@ public final class LineEndingsUtils
* @param lineEndings This is the result of the getLineEndingChars(..) method in this utility class; the actual
* line-ending characters, not null.
* @param atEndOfFile The end-of-file line ending, if true then the resulting file will have a new line at the end
- * even if the input didn't have one, if false then the resulting file will have no new line at the end
- * even if the input did have one, null to determine whether to have a new line at the end of the file
- * based on the input file
+ * even if the input didn't have one, if false then the resulting file will have no new line at
+ * the end even if the input did have one, null to determine whether to have a new line at the
+ * end of the file based on the input file
* @param encoding The encoding to use, null for platform encoding
+ * @throws IOException .
*/
public static void convertLineEndings( @Nonnull File source, @Nonnull File dest, LineEndings lineEndings,
Boolean atEndOfFile, String encoding )
@@ -153,12 +154,13 @@ public final class LineEndingsUtils
* @param in The source reader
* @param lineEndings This is the result of the getLineEndingChars(..) method in this utility class; the actual
* line-ending characters, not null.
- * @param in with proper line endings.
+ * @return an input stream that enforces a specifi line ending style
*/
public static InputStream lineEndingConverter( @Nonnull InputStream in, LineEndings lineEndings )
throws IOException
{
- return lineEndings.isNewLine() ? new LinuxLineFeedInputStream( in, false )
+ return lineEndings.isNewLine()
+ ? new LinuxLineFeedInputStream( in, false )
: lineEndings.isCrLF() ? new WindowsLineFeedInputStream( in, false ) : in;
}
@@ -180,7 +182,14 @@ public final class LineEndingsUtils
return result;
}
- @Nullable public static String getLineEndingCharacters( @Nullable String lineEnding )
+ /**
+ * Returns the appopriate line ending characters for the specified style
+ * @param lineEnding The name of the line ending style, see org.apache.maven.plugin.assembly.utils.LineEndings#valueOf
+ * @return The proper line ending characters
+ * @throws AssemblyFormattingException
+ */
+ @Nullable
+ public static String getLineEndingCharacters( @Nullable String lineEnding )
throws AssemblyFormattingException
{