Fix some compiler/IntelliJ warnings

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1746274 13f79535-47bb-0310-9956-ffa450edef68

15 files changed, 35 insertions, 49 deletions

diff --git a/src/java/org/apache/poi/util/ByteField.java b/src/java/org/apache/poi/util/ByteField.java
index 323fee8d67..ca62277918 100644
--- a/src/java/org/apache/poi/util/ByteField.java
+++ b/src/java/org/apache/poi/util/ByteField.java
@@ -182,7 +182,7 @@ public class ByteField
      */
 
     public void readFromStream(final InputStream stream)
-        throws IOException, BufferUnderrunException
+        throws IOException
     {
     	// TODO - are these ~Field used / necessary
     	int ib = stream.read();
diff --git a/src/java/org/apache/poi/util/CloseIgnoringInputStream.java b/src/java/org/apache/poi/util/CloseIgnoringInputStream.java
index 66e42c258c..82247b13af 100644
--- a/src/java/org/apache/poi/util/CloseIgnoringInputStream.java
+++ b/src/java/org/apache/poi/util/CloseIgnoringInputStream.java
@@ -33,7 +33,6 @@ public class CloseIgnoringInputStream extends FilterInputStream {
    }
 
    public void close() {
-      // Does nothing and ignores you
-      return;
+      // Does nothing and ignores closing the wrapped stream
    }
 }
diff --git a/src/java/org/apache/poi/util/FixedField.java b/src/java/org/apache/poi/util/FixedField.java
index efc74e6988..45d6c6f714 100644
--- a/src/java/org/apache/poi/util/FixedField.java
+++ b/src/java/org/apache/poi/util/FixedField.java
@@ -41,7 +41,7 @@ public interface FixedField
      *            of the array's valid index range
      */
 
-    public void readFromBytes(byte [] data)
+    void readFromBytes(byte [] data)
         throws ArrayIndexOutOfBoundsException;
 
     /**
@@ -56,8 +56,8 @@ public interface FixedField
      *            the InputStream
      */
 
-    public void readFromStream(InputStream stream)
-        throws IOException, BufferUnderrunException;
+    void readFromStream(InputStream stream)
+        throws IOException;
 
     /**
      * write the value out to an array of bytes at the appropriate
@@ -70,7 +70,7 @@ public interface FixedField
      *            of the array's valid index range
      */
 
-    public void writeToBytes(byte [] data)
+    void writeToBytes(byte [] data)
         throws ArrayIndexOutOfBoundsException;
 
     /**
@@ -79,6 +79,6 @@ public interface FixedField
      * @return the value as a String
      */
 
-    public String toString();
+    String toString();
 }   // end public interface FixedField
 
diff --git a/src/java/org/apache/poi/util/IntegerField.java b/src/java/org/apache/poi/util/IntegerField.java
index 39f5a21aeb..c86a008b77 100644
--- a/src/java/org/apache/poi/util/IntegerField.java
+++ b/src/java/org/apache/poi/util/IntegerField.java
@@ -182,7 +182,7 @@ public class IntegerField
      */
 
     public void readFromStream(final InputStream stream)
-        throws IOException, BufferUnderrunException
+        throws IOException
     {
         _value = LittleEndian.readInt(stream);
     }
diff --git a/src/java/org/apache/poi/util/LittleEndianConsts.java b/src/java/org/apache/poi/util/LittleEndianConsts.java
index 472fa3dba3..9f7e4a21a5 100644
--- a/src/java/org/apache/poi/util/LittleEndianConsts.java
+++ b/src/java/org/apache/poi/util/LittleEndianConsts.java
@@ -26,14 +26,11 @@ package org.apache.poi.util;
  * @author Andrew C. Oliver (acoliver at apache dot org)
  */
 
-public interface LittleEndianConsts
-{
-
+public interface LittleEndianConsts {
     // sizes of various numbers in this environment
-    public static final int BYTE_SIZE   = 1;
-    public static final int SHORT_SIZE  = 2;
-    public static final int INT_SIZE    = 4;
-    public static final int LONG_SIZE   = 8;
-    public static final int DOUBLE_SIZE = 8;
+    int BYTE_SIZE   = 1;
+    int SHORT_SIZE  = 2;
+    int INT_SIZE    = 4;
+    int LONG_SIZE   = 8;
+    int DOUBLE_SIZE = 8;
 }   // end public interface LittleEndianConsts
-
diff --git a/src/java/org/apache/poi/util/LittleEndianInputStream.java b/src/java/org/apache/poi/util/LittleEndianInputStream.java
index 406570f82f..da42caf3d7 100644
--- a/src/java/org/apache/poi/util/LittleEndianInputStream.java
+++ b/src/java/org/apache/poi/util/LittleEndianInputStream.java
@@ -21,8 +21,6 @@ import java.io.FilterInputStream;
 import java.io.IOException;
 import java.io.InputStream;
 
-import org.apache.poi.util.LittleEndian.BufferUnderrunException;
-
 /**
  * Wraps an {@link InputStream} providing {@link LittleEndianInput}<p/>
  *
@@ -76,14 +74,12 @@ public class LittleEndianInputStream extends FilterInputStream implements Little
      * get an unsigned int value from an InputStream
      * 
      * @return the unsigned int (32-bit) value
-     * @exception IOException
-     *                will be propagated back to the caller
-     * @exception BufferUnderrunException
-     *                if the stream cannot provide enough bytes
+     * @exception RuntimeException
+     *                wraps any IOException thrown from reading the stream.
      */
     public long readUInt() {
        long retNum = readInt();
-       return retNum & 0x00FFFFFFFFl;
+       return retNum & 0x00FFFFFFFFL;
     }
 	
 	public long readLong() {
diff --git a/src/java/org/apache/poi/util/LongField.java b/src/java/org/apache/poi/util/LongField.java
index 8f4fbe263a..9aeffb36ea 100644
--- a/src/java/org/apache/poi/util/LongField.java
+++ b/src/java/org/apache/poi/util/LongField.java
@@ -179,7 +179,7 @@ public class LongField
      */
 
     public void readFromStream(final InputStream stream)
-        throws IOException, BufferUnderrunException
+        throws IOException
     {
         _value = LittleEndian.readLong(stream);
     }
diff --git a/src/java/org/apache/poi/util/POILogFactory.java b/src/java/org/apache/poi/util/POILogFactory.java
index 1227a0d5ca..ba2551de7b 100644
--- a/src/java/org/apache/poi/util/POILogFactory.java
+++ b/src/java/org/apache/poi/util/POILogFactory.java
@@ -72,8 +72,6 @@ public final class POILogFactory {
      * @return a POILogger for the specified class
      */
     public static POILogger getLogger(final String cat) {
-        POILogger logger = null;
-
         // If we haven't found out what logger to use yet,
         //  then do so now
         // Don't look it up until we're first asked, so
@@ -82,7 +80,9 @@ public final class POILogFactory {
         if(_loggerClassName == null) {
         	try {
         		_loggerClassName = System.getProperty("org.apache.poi.util.POILogger");
-        	} catch(Exception e) {}
+        	} catch(Exception e) {
+                // ignore any exception here
+            }
 
         	// Use the default logger if none specified,
         	//  or none could be fetched
@@ -100,7 +100,7 @@ public final class POILogFactory {
 
         // Fetch the right logger for them, creating
         //  it if that's required
-        logger = _loggers.get(cat);
+        POILogger logger = _loggers.get(cat);
         if (logger == null) {
             try {
                 @SuppressWarnings("unchecked")
diff --git a/src/java/org/apache/poi/util/RLEDecompressingInputStream.java b/src/java/org/apache/poi/util/RLEDecompressingInputStream.java
index 08d9c2f983..de18fee36c 100644
--- a/src/java/org/apache/poi/util/RLEDecompressingInputStream.java
+++ b/src/java/org/apache/poi/util/RLEDecompressingInputStream.java
@@ -67,7 +67,7 @@ public class RLEDecompressingInputStream extends InputStream {
     /**
      * Creates a new wrapper RLE Decompression InputStream.
      * 
-     * @param in
+     * @param in The stream to wrap with the RLE Decompression
      * @throws IOException
      */
     public RLEDecompressingInputStream(InputStream in) throws IOException {
@@ -275,11 +275,11 @@ public class RLEDecompressingInputStream extends InputStream {
         return (b0 & 0xFF) | ((b1 & 0xFF) << 8) | ((b2 & 0xFF) << 16) | ((b3 & 0xFF) << 24);
     }
 
-    public static final byte[] decompress(byte[] compressed) throws IOException {
+    public static byte[] decompress(byte[] compressed) throws IOException {
         return decompress(compressed, 0, compressed.length);
     }
     
-    public static final byte[] decompress(byte[] compressed, int offset, int length) throws IOException {
+    public static byte[] decompress(byte[] compressed, int offset, int length) throws IOException {
         ByteArrayOutputStream out = new ByteArrayOutputStream();
         InputStream instream = new ByteArrayInputStream(compressed, offset, length);
         InputStream stream = new RLEDecompressingInputStream(instream);
diff --git a/src/java/org/apache/poi/util/ShortField.java b/src/java/org/apache/poi/util/ShortField.java
index 4a9b0db4f5..29d91df7f4 100644
--- a/src/java/org/apache/poi/util/ShortField.java
+++ b/src/java/org/apache/poi/util/ShortField.java
@@ -179,7 +179,7 @@ public class ShortField
      */
 
     public void readFromStream(final InputStream stream)
-        throws IOException, BufferUnderrunException
+        throws IOException
     {
         _value = LittleEndian.readShort(stream);
     }
diff --git a/src/java/org/apache/poi/util/StringUtil.java b/src/java/org/apache/poi/util/StringUtil.java
index cb465b241c..afec8225d4 100644
--- a/src/java/org/apache/poi/util/StringUtil.java
+++ b/src/java/org/apache/poi/util/StringUtil.java
@@ -283,7 +283,7 @@ public class StringUtil {
 	/**
 	 * Checks to see if a given String needs to be represented as Unicode
 	 *
-	 * @param value
+	 * @param value The string to look at.
 	 * @return true if string needs Unicode to be represented.
 	 */
 	public static boolean isUnicodeString(final String value) {
diff --git a/src/java/org/apache/poi/util/SystemOutLogger.java b/src/java/org/apache/poi/util/SystemOutLogger.java
index a13882f56d..e665ba6324 100644
--- a/src/java/org/apache/poi/util/SystemOutLogger.java
+++ b/src/java/org/apache/poi/util/SystemOutLogger.java
@@ -87,10 +87,7 @@ public class SystemOutLogger extends POILogger
             currentLevel = POILogger.DEBUG;
         }
 
-        if (level >= currentLevel) {
-            return true;
-        }
-        return false;
+        return level >= currentLevel;
     }
 
 
diff --git a/src/java/org/apache/poi/util/TempFileCreationStrategy.java b/src/java/org/apache/poi/util/TempFileCreationStrategy.java
index 1e9ae9cdbb..d7752e766f 100644
--- a/src/java/org/apache/poi/util/TempFileCreationStrategy.java
+++ b/src/java/org/apache/poi/util/TempFileCreationStrategy.java
@@ -34,5 +34,5 @@ public interface TempFileCreationStrategy {
      * 
      * @throws IOException If no temporary file could be created.
      */
-    public File createTempFile(String prefix, String suffix) throws IOException;
+    File createTempFile(String prefix, String suffix) throws IOException;
 }
diff --git a/src/java/org/apache/poi/util/Units.java b/src/java/org/apache/poi/util/Units.java
index 6649c1f860..4ee12cb9c5 100644
--- a/src/java/org/apache/poi/util/Units.java
+++ b/src/java/org/apache/poi/util/Units.java
@@ -75,23 +75,22 @@ public class Units {
     /**

      * Converts a value of type FixedPoint to a floating point

      *

-     * @param fixedPoint

+     * @param fixedPoint value in fixed point notation

      * @return floating point (double)

      * 

      * @see <a href="http://msdn.microsoft.com/en-us/library/dd910765(v=office.12).aspx">[MS-OSHARED] - 2.2.1.6 FixedPoint</a>

      */

     public static double fixedPointToDouble(int fixedPoint) {

         int i = (fixedPoint >> 16);

-        int f = (fixedPoint >> 0) & 0xFFFF;

-        double floatPoint = (i + f/65536d);

-        return floatPoint;

+        int f = fixedPoint & 0xFFFF;

+        return (i + f/65536d);

     }

     

     /**

      * Converts a value of type floating point to a FixedPoint

      *

-     * @param floatPoint

-     * @return fixedPoint

+     * @param floatPoint value in floating point notation

+     * @return fixedPoint value in fixed points notation

      * 

      * @see <a href="http://msdn.microsoft.com/en-us/library/dd910765(v=office.12).aspx">[MS-OSHARED] - 2.2.1.6 FixedPoint</a>

      */

@@ -100,8 +99,7 @@ public class Units {
         double integralPart = floatPoint - fractionalPart;

         int i = (int)Math.floor(integralPart);

         int f = (int)Math.rint(fractionalPart*65536d);

-        int fixedPoint = (i << 16) | (f & 0xFFFF);

-        return fixedPoint;

+        return (i << 16) | (f & 0xFFFF);

     }

 

     public static double masterToPoints(int masterDPI) {

diff --git a/src/java/org/apache/poi/util/XMLHelper.java b/src/java/org/apache/poi/util/XMLHelper.java
index 22d27208be..8797475461 100644
--- a/src/java/org/apache/poi/util/XMLHelper.java
+++ b/src/java/org/apache/poi/util/XMLHelper.java
@@ -22,7 +22,6 @@ import javax.xml.parsers.DocumentBuilderFactory;
 
 /**
  * Helper methods for working with javax.xml classes.
- * @see org.apache.poi.util.SAXHelper
  */
 public final class XMLHelper
 {