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 2012/10/15 21:49:16 UTC

svn commit: r1398477 - in /maven/shared/trunk/maven-shared-utils/src: main/java/org/apache/maven/shared/utils/ test/java/org/apache/maven/shared/utils/

Author: krosenvold
Date: Mon Oct 15 19:49:16 2012
New Revision: 1398477

URL: http://svn.apache.org/viewvc?rev=1398477&view=rev
Log:
o Cleaned code

Modified:
    maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/Os.java
    maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/PathTool.java
    maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/PropertyUtils.java
    maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/ReaderFactory.java
    maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/StringUtils.java
    maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/WriterFactory.java
    maven/shared/trunk/maven-shared-utils/src/test/java/org/apache/maven/shared/utils/OsTest.java

Modified: maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/Os.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/Os.java?rev=1398477&r1=1398476&r2=1398477&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/Os.java (original)
+++ maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/Os.java Mon Oct 15 19:49:16 2012
@@ -64,21 +64,6 @@ public class Os
     private String family;
 
     /**
-     * Name of OS
-     */
-    private String name;
-
-    /**
-     * version of OS
-     */
-    private String version;
-
-    /**
-     * OS architecture
-     */
-    private String arch;
-
-    /**
      * OS family that can be tested for. {@value}
      */
     public static final String FAMILY_WINDOWS = "windows";
@@ -225,7 +210,7 @@ public class Os
      */
     boolean eval()
     {
-        return isOs( family, name, arch, version );
+        return isOs( family, null, null, null);
     }
 
     /**

Modified: maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/PathTool.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/PathTool.java?rev=1398477&r1=1398476&r2=1398477&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/PathTool.java (original)
+++ maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/PathTool.java Mon Oct 15 19:49:16 2012
@@ -22,6 +22,9 @@ package org.apache.maven.shared.utils;
 import java.io.File;
 import java.util.StringTokenizer;
 
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
 /**
  * Path tool contains static methods to assist in determining path-related
  * information such as relative paths.
@@ -62,7 +65,7 @@ public class PathTool
      *         the base directory, <code>basedir</code> is null or zero-length,
      *         or <code>filename</code> is null or zero-length.
      */
-    public static String getRelativePath( String basedir, String filename )
+    public static String getRelativePath( @Nullable String basedir, @Nullable String filename )
     {
         basedir = uppercaseDrive( basedir );
         filename = uppercaseDrive( filename );
@@ -191,7 +194,7 @@ public class PathTool
      *         terminated with a forward slash.  A zero-length string is
      *         returned if: the filename is zero-length.
      */
-    private static String determineRelativePath( String filename, String separator )
+    private static @Nonnull String determineRelativePath( @Nonnull String filename, @Nonnull String separator )
     {
         if ( filename.length() == 0 )
         {
@@ -251,7 +254,7 @@ public class PathTool
      * @param path old path
      * @return String
      */
-    static String uppercaseDrive( String path )
+    static String uppercaseDrive( @Nullable String path )
     {
         if ( path == null )
         {
@@ -264,7 +267,7 @@ public class PathTool
         return path;
     }
 
-    private static String buildRelativePath( String toPath, String fromPath, final char separatorChar )
+    private static String buildRelativePath( @Nonnull String toPath, @Nonnull String fromPath, final char separatorChar )
     {
         // use tokeniser to traverse paths and for lazy checking
         StringTokenizer toTokeniser = new StringTokenizer( toPath, String.valueOf( separatorChar ) );

Modified: maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/PropertyUtils.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/PropertyUtils.java?rev=1398477&r1=1398476&r2=1398477&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/PropertyUtils.java (original)
+++ maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/PropertyUtils.java Mon Oct 15 19:49:16 2012
@@ -25,6 +25,9 @@ import java.io.IOException;
 import java.util.Properties;
 import org.apache.maven.shared.utils.io.IOUtil;
 
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
 public class PropertyUtils
 {
 
@@ -33,7 +36,7 @@ public class PropertyUtils
         // should throw new IllegalAccessError( "Utility class" );
     }
 
-    public static java.util.Properties loadProperties( java.net.URL url )
+    public static java.util.Properties loadProperties( @Nonnull java.net.URL url )
     {
         try
         {
@@ -46,7 +49,7 @@ public class PropertyUtils
         return null;
     }
 
-    public static java.util.Properties loadProperties( java.io.File file )
+    public static java.util.Properties loadProperties( @Nonnull java.io.File file )
     {
         try
         {
@@ -59,7 +62,7 @@ public class PropertyUtils
         return null;
     }
 
-    public static java.util.Properties loadProperties( java.io.InputStream is )
+    public static java.util.Properties loadProperties( @Nullable java.io.InputStream is )
     {
         try
         {

Modified: maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/ReaderFactory.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/ReaderFactory.java?rev=1398477&r1=1398476&r2=1398477&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/ReaderFactory.java (original)
+++ maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/ReaderFactory.java Mon Oct 15 19:49:16 2012
@@ -32,6 +32,8 @@ import java.net.URL;
 import java.nio.charset.Charset;
 import org.apache.commons.io.input.XmlStreamReader;
 
+import javax.annotation.Nonnull;
+
 
 /**
  * Utility to create Readers from streams, with explicit encoding choice: platform default,
@@ -106,7 +108,7 @@ public class ReaderFactory
      * @throws IOException if any.
      * @see XmlStreamReader
      */
-    public static Reader newXmlReader( InputStream in )
+    public static Reader newXmlReader( @Nonnull InputStream in )
         throws IOException
     {
         return new XmlStreamReader( in );
@@ -120,7 +122,7 @@ public class ReaderFactory
      * @throws IOException if any.
      * @see XmlStreamReader
      */
-    public static Reader newXmlReader( File file )
+    public static Reader newXmlReader( @Nonnull File file )
         throws IOException
     {
         return new XmlStreamReader( file );
@@ -134,7 +136,7 @@ public class ReaderFactory
      * @throws IOException if any.
      * @see XmlStreamReader
      */
-    public static Reader newXmlReader( URL url )
+    public static Reader newXmlReader( @Nonnull URL url )
         throws IOException
     {
         return new XmlStreamReader( url );
@@ -148,7 +150,7 @@ public class ReaderFactory
      * @throws FileNotFoundException if any.
      * @see Charset#defaultCharset()
      */
-    public static Reader newPlatformReader( File file )
+    public static Reader newPlatformReader( @Nonnull File file )
         throws FileNotFoundException
     {
         return new FileReader( file );
@@ -163,7 +165,7 @@ public class ReaderFactory
      * @throws UnsupportedEncodingException if any.
      * @see <a href="http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html">Supported encodings</a>
      */
-    public static Reader newReader( InputStream in, String encoding )
+    public static Reader newReader( @Nonnull InputStream in, @Nonnull String encoding )
         throws UnsupportedEncodingException
     {
         return new InputStreamReader( in, encoding );
@@ -179,7 +181,7 @@ public class ReaderFactory
      * @throws UnsupportedEncodingException if any.
      * @see <a href="http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html">Supported encodings</a>
      */
-    public static Reader newReader( File file, String encoding )
+    public static Reader newReader( @Nonnull File file, @Nonnull String encoding )
         throws FileNotFoundException, UnsupportedEncodingException
     {
         return new InputStreamReader( new FileInputStream( file ), encoding );
@@ -194,7 +196,7 @@ public class ReaderFactory
      * @throws IOException if any.
      * @see <a href="http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html">Supported encodings</a>
      */
-    public static Reader newReader( URL url, String encoding )
+    public static Reader newReader( @Nonnull URL url, @Nonnull String encoding )
         throws IOException
     {
         return new InputStreamReader( url.openStream(), encoding );

Modified: maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/StringUtils.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/StringUtils.java?rev=1398477&r1=1398476&r2=1398477&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/StringUtils.java (original)
+++ maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/StringUtils.java Mon Oct 15 19:49:16 2012
@@ -1669,7 +1669,7 @@ public class StringUtils
      * @return the number of occurances, 0 if the String is <code>null</code>
      * @throws NullPointerException if sub is <code>null</code>
      */
-    public static int countMatches( String str, @Nonnull String sub )
+    public static int countMatches( @Nullable String str, @Nonnull String sub )
     {
         if ( sub.equals( "" ) )
         {

Modified: maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/WriterFactory.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/WriterFactory.java?rev=1398477&r1=1398476&r2=1398477&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/WriterFactory.java (original)
+++ maven/shared/trunk/maven-shared-utils/src/main/java/org/apache/maven/shared/utils/WriterFactory.java Mon Oct 15 19:49:16 2012
@@ -32,6 +32,8 @@ import java.nio.charset.Charset;
 
 import org.apache.commons.io.output.XmlStreamWriter;
 
+import javax.annotation.Nonnull;
+
 /**
  * Utility to create Writers, with explicit encoding choice: platform default,
  * XML, or specified.
@@ -99,7 +101,7 @@ public class WriterFactory
      * @throws IOException if any.
      * @see XmlStreamWriter
      */
-    public static XmlStreamWriter newXmlWriter( OutputStream out )
+    public static XmlStreamWriter newXmlWriter( @Nonnull OutputStream out )
         throws IOException
     {
         return new XmlStreamWriter( out );
@@ -113,7 +115,7 @@ public class WriterFactory
      * @throws IOException if any.
      * @see XmlStreamWriter
      */
-    public static XmlStreamWriter newXmlWriter( File file )
+    public static XmlStreamWriter newXmlWriter( @Nonnull File file )
         throws IOException
     {
         return new XmlStreamWriter( file );
@@ -126,7 +128,7 @@ public class WriterFactory
      * @return a writer instance for the output stream using the default platform charset.
      * @see Charset#defaultCharset()
      */
-    public static Writer newPlatformWriter( OutputStream out )
+    public static Writer newPlatformWriter( @Nonnull OutputStream out )
     {
         return new OutputStreamWriter( out );
     }
@@ -139,7 +141,7 @@ public class WriterFactory
      * @throws IOException if any.
      * @see Charset#defaultCharset()
      */
-    public static Writer newPlatformWriter( File file )
+    public static Writer newPlatformWriter( @Nonnull File file )
         throws IOException
     {
         return new FileWriter( file );
@@ -154,7 +156,7 @@ public class WriterFactory
      * @throws UnsupportedEncodingException if any.
      * @see <a href="http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html">Supported encodings</a>
      */
-    public static Writer newWriter( OutputStream out, String encoding )
+    public static Writer newWriter( @Nonnull OutputStream out, @Nonnull String encoding )
         throws UnsupportedEncodingException
     {
         return new OutputStreamWriter( out, encoding );
@@ -170,7 +172,7 @@ public class WriterFactory
      * @throws FileNotFoundException if any.
      * @see <a href="http://java.sun.com/j2se/1.4.2/docs/guide/intl/encoding.doc.html">Supported encodings</a>
      */
-    public static Writer newWriter( File file, String encoding )
+    public static Writer newWriter( @Nonnull File file, @Nonnull String encoding )
         throws UnsupportedEncodingException, FileNotFoundException
     {
         return newWriter( new FileOutputStream( file ), encoding );

Modified: maven/shared/trunk/maven-shared-utils/src/test/java/org/apache/maven/shared/utils/OsTest.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-shared-utils/src/test/java/org/apache/maven/shared/utils/OsTest.java?rev=1398477&r1=1398476&r2=1398477&view=diff
==============================================================================
--- maven/shared/trunk/maven-shared-utils/src/test/java/org/apache/maven/shared/utils/OsTest.java (original)
+++ maven/shared/trunk/maven-shared-utils/src/test/java/org/apache/maven/shared/utils/OsTest.java Mon Oct 15 19:49:16 2012
@@ -103,8 +103,6 @@ public class OsTest extends Assert
         Os os  = new Os();
         os.eval();
 
-        os = new Os( "unknown" );
-
         assertTrue( Os.isName( Os.FAMILY_OS2 ) );
 
         assertFalse( Os.isName( Os.FAMILY_DOS ) );