Author: tchemit Date: Tue Nov 12 15:21:23 2013 New Revision: 1541101 URL: http://svn.apache.org/r1541101 Log: MSHARED-302 - Use java 5 codestyle + add some javadoc @inheritDoc
Modified: maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/AbstractJarSignerRequest.java maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/DefaultJarSigner.java maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/DefaultJarSignerResult.java maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/JarSignerCommandLineBuilder.java maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/JarSignerRequest.java maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/JarSignerUtil.java Modified: maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/AbstractJarSignerRequest.java URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/AbstractJarSignerRequest.java?rev=1541101&r1=1541100&r2=1541101&view=diff ============================================================================== --- maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/AbstractJarSignerRequest.java (original) +++ maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/AbstractJarSignerRequest.java Tue Nov 12 15:21:23 2013 @@ -69,71 +69,113 @@ public abstract class AbstractJarSignerR */ private StreamConsumer systemErrorStreamConsumer; + /** + * {@inheritDoc} + */ public boolean isVerbose() { return verbose; } + /** + * {@inheritDoc} + */ public String getMaxMemory() { return maxMemory; } + /** + * {@inheritDoc} + */ public String[] getArguments() { return arguments; } + /** + * {@inheritDoc} + */ public File getWorkingDirectory() { return workingDirectory; } + /** + * {@inheritDoc} + */ public File getArchive() { return archive; } + /** + * {@inheritDoc} + */ public StreamConsumer getSystemOutStreamConsumer() { return systemOutStreamConsumer; } + /** + * {@inheritDoc} + */ public StreamConsumer getSystemErrorStreamConsumer() { return systemErrorStreamConsumer; } + /** + * {@inheritDoc} + */ public void setVerbose( boolean verbose ) { this.verbose = verbose; } + /** + * {@inheritDoc} + */ public void setMaxMemory( String maxMemory ) { this.maxMemory = maxMemory; } - public void setArguments( String[] arguments ) + /** + * {@inheritDoc} + */ + public void setArguments( String... arguments ) { this.arguments = arguments; } + /** + * {@inheritDoc} + */ public void setWorkingDirectory( File workingDirectory ) { this.workingDirectory = workingDirectory; } + /** + * {@inheritDoc} + */ public void setArchive( File archive ) { this.archive = archive; } + /** + * {@inheritDoc} + */ public void setSystemOutStreamConsumer( StreamConsumer systemOutStreamConsumer ) { this.systemOutStreamConsumer = systemOutStreamConsumer; } + /** + * {@inheritDoc} + */ public void setSystemErrorStreamConsumer( StreamConsumer systemErrorStreamConsumer ) { this.systemErrorStreamConsumer = systemErrorStreamConsumer; Modified: maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/DefaultJarSigner.java URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/DefaultJarSigner.java?rev=1541101&r1=1541100&r2=1541101&view=diff ============================================================================== --- maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/DefaultJarSigner.java (original) +++ maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/DefaultJarSigner.java Tue Nov 12 15:21:23 2013 @@ -19,14 +19,14 @@ package org.apache.maven.shared.jarsigne * under the License. */ -import org.codehaus.plexus.component.annotations.Component; -import org.codehaus.plexus.logging.AbstractLogEnabled; import org.apache.maven.shared.utils.Os; import org.apache.maven.shared.utils.StringUtils; import org.apache.maven.shared.utils.cli.CommandLineException; import org.apache.maven.shared.utils.cli.CommandLineUtils; import org.apache.maven.shared.utils.cli.Commandline; import org.apache.maven.shared.utils.cli.StreamConsumer; +import org.codehaus.plexus.component.annotations.Component; +import org.codehaus.plexus.logging.AbstractLogEnabled; import java.io.File; import java.io.IOException; @@ -51,6 +51,9 @@ public class DefaultJarSigner */ protected String jarSignerFile; + /** + * {@inheritDoc} + */ public JarSignerResult execute( JarSignerRequest request ) throws JarSignerException { @@ -104,6 +107,9 @@ public class DefaultJarSigner InputStream systemIn = new InputStream() { + /** + * {@inheritDoc} + */ public int read() { return -1; @@ -117,6 +123,9 @@ public class DefaultJarSigner systemOut = new StreamConsumer() { + /** + * {@inheritDoc} + */ public void consumeLine( final String line ) { if ( verbose ) @@ -139,6 +148,9 @@ public class DefaultJarSigner systemErr = new StreamConsumer() { + /** + * {@inheritDoc} + */ public void consumeLine( final String line ) { getLogger().warn( line ); @@ -178,8 +190,7 @@ public class DefaultJarSigner { String command = "jarsigner" + ( Os.isFamily( Os.FAMILY_WINDOWS ) ? ".exe" : "" ); - String executable = - findExecutable( command, System.getProperty( "java.home" ), new String[]{ "../bin", "bin", "../sh" } ); + String executable = findExecutable( command, System.getProperty( "java.home" ), "../bin", "bin", "../sh" ); if ( executable == null ) { @@ -188,9 +199,13 @@ public class DefaultJarSigner String[] variables = { "JDK_HOME", "JAVA_HOME" }; - for ( int i = 0; i < variables.length && executable == null; i++ ) + for ( String variable : variables ) { - executable = findExecutable( command, env.get( variables[i] ), new String[]{ "bin", "sh" } ); + executable = findExecutable( command, env.get( variable ), "bin", "sh" ); + if ( executable != null ) + { + break; + } } } @@ -211,21 +226,23 @@ public class DefaultJarSigner * @param subDirs The sub directories of the home directory to search in, must not be <code>null</code>. * @return The (absolute) path to the command if found, <code>null</code> otherwise. */ - protected String findExecutable( String command, String homeDir, String[] subDirs ) + protected String findExecutable( String command, String homeDir, String... subDirs ) { + String result = null; if ( StringUtils.isNotEmpty( homeDir ) ) { - for ( int i = 0; i < subDirs.length; i++ ) + for ( String subDir : subDirs ) { - File file = new File( new File( homeDir, subDirs[i] ), command ); + File file = new File( new File( homeDir, subDir ), command ); if ( file.isFile() ) { - return file.getAbsolutePath(); + result = file.getAbsolutePath(); + break; } } } - return null; + return result; } } Modified: maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/DefaultJarSignerResult.java URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/DefaultJarSignerResult.java?rev=1541101&r1=1541100&r2=1541101&view=diff ============================================================================== --- maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/DefaultJarSignerResult.java (original) +++ maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/DefaultJarSignerResult.java Tue Nov 12 15:21:23 2013 @@ -54,16 +54,25 @@ public class DefaultJarSignerResult // hide constructor } + /** + * {@inheritDoc} + */ public int getExitCode() { return exitCode; } + /** + * {@inheritDoc} + */ public Commandline getCommandline() { return commandline; } + /** + * {@inheritDoc} + */ public CommandLineException getExecutionException() { return executionException; Modified: maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/JarSignerCommandLineBuilder.java URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/JarSignerCommandLineBuilder.java?rev=1541101&r1=1541100&r2=1541101&view=diff ============================================================================== --- maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/JarSignerCommandLineBuilder.java (original) +++ maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/JarSignerCommandLineBuilder.java Tue Nov 12 15:21:23 2013 @@ -19,10 +19,10 @@ package org.apache.maven.shared.jarsigne * under the License. */ -import org.codehaus.plexus.logging.Logger; -import org.codehaus.plexus.logging.console.ConsoleLogger; import org.apache.maven.shared.utils.StringUtils; import org.apache.maven.shared.utils.cli.Commandline; +import org.codehaus.plexus.logging.Logger; +import org.codehaus.plexus.logging.console.ConsoleLogger; import java.io.File; import java.io.IOException; Modified: maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/JarSignerRequest.java URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/JarSignerRequest.java?rev=1541101&r1=1541100&r2=1541101&view=diff ============================================================================== --- maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/JarSignerRequest.java (original) +++ maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/JarSignerRequest.java Tue Nov 12 15:21:23 2013 @@ -110,7 +110,7 @@ public interface JarSignerRequest * * @param arguments the new value of the field {@code arguments}. */ - void setArguments( String[] arguments ); + void setArguments( String... arguments ); /** * Sets the new given value to the field {@code workingDirectory} of the request. Modified: maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/JarSignerUtil.java URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/JarSignerUtil.java?rev=1541101&r1=1541100&r2=1541101&view=diff ============================================================================== --- maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/JarSignerUtil.java (original) +++ maven/shared/trunk/maven-jarsigner/src/main/java/org/apache/maven/shared/jarsigner/JarSignerUtil.java Tue Nov 12 15:21:23 2013 @@ -34,7 +34,7 @@ import java.util.zip.ZipOutputStream; /** * Useful methods. - * + * * @author tchemit <che...@codelutin.com> * @version $Id$ * @since 1.0 @@ -50,18 +50,19 @@ public class JarSignerUtil /** * Checks whether the specified file is a JAR file. For our purposes, a ZIP file is a ZIP stream with at least one * entry. - * + * * @param file The file to check, must not be <code>null</code>. * @return <code>true</code> if the file looks like a ZIP file, <code>false</code> otherwise. */ public static boolean isZipFile( final File file ) { + boolean result = false; try { ZipInputStream zis = new ZipInputStream( new FileInputStream( file ) ); try { - return zis.getNextEntry() != null; + result = zis.getNextEntry() != null; } finally { @@ -73,13 +74,13 @@ public class JarSignerUtil // ignore, will fail below } - return false; + return result; } /** * Removes any existing signatures from the specified JAR file. We will stream from the input JAR directly to the * output JAR to retain as much metadata from the original JAR as possible. - * + * * @param jarFile The JAR file to unsign, must not be <code>null</code>. * @throws java.io.IOException */ @@ -122,7 +123,7 @@ public class JarSignerUtil /** * Scans an archive for existing signatures. - * + * * @param jarFile The archive to scan, must not be <code>null</code>. * @return <code>true</code>, if the archive contains at least one signature file; <code>false</code>, if the archive * does not contain any signature files. @@ -165,7 +166,7 @@ public class JarSignerUtil in.close(); } } - catch ( final IOException e ) + catch ( IOException e ) { if ( !suppressExceptionOnClose ) { @@ -178,12 +179,13 @@ public class JarSignerUtil /** * Checks whether the specified JAR file entry denotes a signature-related file, i.e. matches * <code>META-INF/*.SF</code>, <code>META-INF/*.DSA</code> or <code>META-INF/*.RSA</code>. - * + * * @param entryName The name of the JAR file entry to check, must not be <code>null</code>. * @return <code>true</code> if the entry is related to a signature, <code>false</code> otherwise. */ private static boolean isSignatureFile( String entryName ) { + boolean result = false; if ( entryName.regionMatches( true, 0, "META-INF", 0, 8 ) ) { entryName = entryName.replace( '\\', '/' ); @@ -192,22 +194,22 @@ public class JarSignerUtil { if ( entryName.regionMatches( true, entryName.length() - 3, ".SF", 0, 3 ) ) { - return true; + result = true; } - if ( entryName.regionMatches( true, entryName.length() - 4, ".DSA", 0, 4 ) ) + else if ( entryName.regionMatches( true, entryName.length() - 4, ".DSA", 0, 4 ) ) { - return true; + result = true; } - if ( entryName.regionMatches( true, entryName.length() - 4, ".RSA", 0, 4 ) ) + else if ( entryName.regionMatches( true, entryName.length() - 4, ".RSA", 0, 4 ) ) { - return true; + result = true; } - if ( entryName.regionMatches( true, entryName.length() - 3, ".EC", 0, 3 ) ) + else if ( entryName.regionMatches( true, entryName.length() - 3, ".EC", 0, 3 ) ) { - return true; + result = true; } } } - return false; + return result; } }