Changeset 6127 in josm for trunk/src/com/drew/lang

Timestamp:

2013-08-09T18:05:11+02:00 (11 years ago)

Author:

bastiK

Message:

applied #8895 - Upgrade metadata-extractor to v. 2.6.4 (patch by ebourg)

Location:

trunk/src/com/drew/lang

Files:

• BufferBoundsException.java (added)
• BufferReader.java (added)
• ByteArrayReader.java (added)
• CompoundException.java (modified) (3 diffs)
• GeoLocation.java (added)
• NullOutputStream.java (modified) (2 diffs)
• Rational.java (modified) (14 diffs)
• StringUtil.java (added)
• annotations (added)
• annotations/NotNull.java (added)
• annotations/Nullable.java (added)
• annotations/SuppressWarnings.java (added)

trunk/src/com/drew/lang/CompoundException.java

@@ -1 +1 @@
 /*
- * This is public domain software - that is, you can do whatever you want
- * with it, and include it software that is licensed under the GNU or the
- * BSD license, or whatever other licence you choose, including proprietary
- * closed source licenses.  I do ask that you leave this header in tact.
+ * Copyright 2002-2012 Drew Noakes
  *
- * If you make modifications to this code that you think would benefit the
- * wider community, please send me a copy and I'll post it on my site.
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
  *
- * If you make use of this code, I'd appreciate hearing about it.
- *   drew@drewnoakes.com
- * Latest version of this software kept at
- *   http://drewnoakes.com/
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ *
+ * More information about this project is available at:
+ *
+ *    http://drewnoakes.com/code/exif/
+ *    http://code.google.com/p/metadata-extractor/
  */
 package com.drew.lang;
+
+import com.drew.lang.annotations.NotNull;
+import com.drew.lang.annotations.Nullable;
 
 import java.io.PrintStream;
@@ -22 +31 @@
  * unavailable in previous versions.  This class allows support
  * of these previous JDK versions.
+ *
+ * @author Drew Noakes http://drewnoakes.com
  */
 public class CompoundException extends Exception
 {
-    private final Throwable _innnerException;
+    private static final long serialVersionUID = -9207883813472069925L;
 
-    public CompoundException(String msg)
+    @Nullable
+    private final Throwable _innerException;
+
+    public CompoundException(@Nullable String msg)
     {
         this(msg, null);
     }
 
-    public CompoundException(Throwable exception)
+    public CompoundException(@Nullable Throwable exception)
     {
         this(null, exception);
     }
 
-    public CompoundException(String msg, Throwable innerException)
+    public CompoundException(@Nullable String msg, @Nullable Throwable innerException)
     {
         super(msg);
-        _innnerException = innerException;
+        _innerException = innerException;
     }
 
+    @Nullable
     public Throwable getInnerException()
     {
-        return _innnerException;
+        return _innerException;
     }
 
+    @NotNull
     public String toString()
     {
-        StringBuffer sbuffer = new StringBuffer();
-        sbuffer.append(super.toString());
-        if (_innnerException != null) {
-            sbuffer.append("\n");
-            sbuffer.append("--- inner exception ---");
-            sbuffer.append("\n");
-            sbuffer.append(_innnerException.toString());
+        StringBuilder string = new StringBuilder();
+        string.append(super.toString());
+        if (_innerException != null) {
+            string.append("\n");
+            string.append("--- inner exception ---");
+            string.append("\n");
+            string.append(_innerException.toString());
         }
-        return sbuffer.toString();
+        return string.toString();
     }
 
-    public void printStackTrace(PrintStream s)
+    public void printStackTrace(@NotNull PrintStream s)
     {
         super.printStackTrace(s);
-        if (_innnerException != null) {
+        if (_innerException != null) {
             s.println("--- inner exception ---");
-            _innnerException.printStackTrace(s);
+            _innerException.printStackTrace(s);
         }
     }
 
-    public void printStackTrace(PrintWriter s)
+    public void printStackTrace(@NotNull PrintWriter s)
     {
         super.printStackTrace(s);
-        if (_innnerException != null) {
+        if (_innerException != null) {
             s.println("--- inner exception ---");
-            _innnerException.printStackTrace(s);
+            _innerException.printStackTrace(s);
         }
     }
@@ -82 +98 @@
     {
         super.printStackTrace();
-        if (_innnerException != null) {
+        if (_innerException != null) {
             System.err.println("--- inner exception ---");
-            _innnerException.printStackTrace();
+            _innerException.printStackTrace();
         }
     }

trunk/src/com/drew/lang/NullOutputStream.java

@@ -1 @@
-/**
- * This is public domain software - that is, you can do whatever you want
- * with it, and include it software that is licensed under the GNU or the
- * BSD license, or whatever other licence you choose, including proprietary
- * closed source licenses.  I do ask that you leave this header in tact.
+/*
+ * Copyright 2002-2012 Drew Noakes
  *
- * If you make modifications to this code that you think would benefit the
- * wider community, please send me a copy and I'll post it on my site.
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
  *
- * If you make use of this code, I'd appreciate hearing about it.
- *   drew@drewnoakes.com
- * Latest version of this software kept at
- *   http://drewnoakes.com/
+ *        http://www.apache.org/licenses/LICENSE-2.0
  *
- * Created by dnoakes on Dec 15, 2002 3:30:59 PM using IntelliJ IDEA.
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ *
+ * More information about this project is available at:
+ *
+ *    http://drewnoakes.com/code/exif/
+ *    http://code.google.com/p/metadata-extractor/
  */
 package com.drew.lang;
@@ -20 +24 @@
 import java.io.OutputStream;
 
+/**
+ * An implementation of OutputSteam that ignores write requests by doing nothing.  This class may be useful in tests.
+ *
+ * @author Drew Noakes http://drewnoakes.com
+ */
 public class NullOutputStream extends OutputStream
 {

trunk/src/com/drew/lang/Rational.java

@@ -1 +1 @@
 /*
- * Rational.java
- *
- * This class is public domain software - that is, you can do whatever you want
- * with it, and include it software that is licensed under the GNU or the
- * BSD license, or whatever other licence you choose, including proprietary
- * closed source licenses.  Similarly, I release this Java version under the
- * same license, though I do ask that you leave this header in tact.
- *
- * If you make modifications to this code that you think would benefit the
- * wider community, please send me a copy and I'll post it on my site.
- *
- * If you make use of this code, I'd appreciate hearing about it.
- *   drew.noakes@drewnoakes.com
- * Latest version of this software kept at
- *   http://drewnoakes.com/
- *
- * Created on 6 May 2002, 18:06
- * Updated 26 Aug 2002 by Drew
- * - Added toSimpleString() method, which returns a simplified and hopefully more
- *   readable version of the Rational.  i.e. 2/10 -> 1/5, and 10/2 -> 5
- * Modified 29 Oct 2002 (v1.2)
- * - Improved toSimpleString() to factor more complex rational numbers into
- *   a simpler form
- *     i.e.
- *       10/15 -> 2/3
- * - toSimpleString() now accepts a boolean flag, 'allowDecimals' which will
- *   display the rational number in decimal form if it fits within 5 digits
- *     i.e.
- *       3/4 -> 0.75 when allowDecimal == true
+ * Copyright 2002-2012 Drew Noakes
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ *
+ * More information about this project is available at:
+ *
+ *    http://drewnoakes.com/code/exif/
+ *    http://code.google.com/p/metadata-extractor/
  */
 
 package com.drew.lang;
+
+import com.drew.lang.annotations.NotNull;
+import com.drew.lang.annotations.Nullable;
 
 import java.io.Serializable;
@@ -38 +30 @@
  * Immutable class for holding a rational number without loss of precision.  Provides
  * a familiar representation via toString() in form <code>numerator/denominator</code>.
- * <p>
- * @author  Drew Noakes http://drewnoakes.com
+ *
+ * @author Drew Noakes http://drewnoakes.com
  */
 public class Rational extends java.lang.Number implements Serializable
 {
-    /**
-     * Holds the numerator.
-     */
-    private final int numerator;
-
-    /**
-     * Holds the denominator.
-     */
-    private final int denominator;
-
-    private int maxSimplificationCalculations = 1000;
+    private static final long serialVersionUID = 510688928138848770L;
+
+    /** Holds the numerator. */
+    private final long _numerator;
+
+    /** Holds the denominator. */
+    private final long _denominator;
 
     /**
@@ -60 +48 @@
      * with them!
      */
-    public Rational(int numerator, int denominator)
-    {
-        this.numerator = numerator;
-        this.denominator = denominator;
+    public Rational(long numerator, long denominator)
+    {
+        _numerator = numerator;
+        _denominator = denominator;
     }
 
@@ -70 +58 @@
      * This may involve rounding.
      *
-     * @return  the numeric value represented by this object after conversion
-     *          to type <code>double</code>.
+     * @return the numeric value represented by this object after conversion
+     *         to type <code>double</code>.
      */
     public double doubleValue()
     {
-        return (double)numerator / (double)denominator;
+        return (double) _numerator / (double) _denominator;
     }
 
@@ -82 +70 @@
      * This may involve rounding.
      *
-     * @return  the numeric value represented by this object after conversion
-     *          to type <code>float</code>.
+     * @return the numeric value represented by this object after conversion
+     *         to type <code>float</code>.
      */
     public float floatValue()
     {
-        return (float)numerator / (float)denominator;
+        return (float) _numerator / (float) _denominator;
     }
 
@@ -95 +83 @@
      * casts the result of <code>doubleValue()</code> to <code>byte</code>.
      *
-     * @return  the numeric value represented by this object after conversion
-     *          to type <code>byte</code>.
+     * @return the numeric value represented by this object after conversion
+     *         to type <code>byte</code>.
      */
     public final byte byteValue()
     {
-        return (byte)doubleValue();
+        return (byte) doubleValue();
     }
 
@@ -108 +96 @@
      * casts the result of <code>doubleValue()</code> to <code>int</code>.
      *
-     * @return  the numeric value represented by this object after conversion
-     *          to type <code>int</code>.
+     * @return the numeric value represented by this object after conversion
+     *         to type <code>int</code>.
      */
     public final int intValue()
     {
-        return (int)doubleValue();
+        return (int) doubleValue();
     }
 
@@ -121 +109 @@
      * casts the result of <code>doubleValue()</code> to <code>long</code>.
      *
-     * @return  the numeric value represented by this object after conversion
-     *          to type <code>long</code>.
+     * @return the numeric value represented by this object after conversion
+     *         to type <code>long</code>.
      */
     public final long longValue()
     {
-        return (long)doubleValue();
+        return (long) doubleValue();
     }
 
@@ -134 +122 @@
      * casts the result of <code>doubleValue()</code> to <code>short</code>.
      *
-     * @return  the numeric value represented by this object after conversion
-     *          to type <code>short</code>.
+     * @return the numeric value represented by this object after conversion
+     *         to type <code>short</code>.
      */
     public final short shortValue()
     {
-        return (short)doubleValue();
-    }
-
-
-    /**
-     * Returns the denominator.
-     */
-    public final int getDenominator()
-    {
-        return this.denominator;
-    }
-
-    /**
-     * Returns the numerator.
-     */
-    public final int getNumerator()
-    {
-        return this.numerator;
-    }
-
-    /**
-     * Returns the reciprocal value of this obejct as a new Rational.
+        return (short) doubleValue();
+    }
+
+
+    /** Returns the denominator. */
+    public final long getDenominator()
+    {
+        return this._denominator;
+    }
+
+    /** Returns the numerator. */
+    public final long getNumerator()
+    {
+        return this._numerator;
+    }
+
+    /**
+     * Returns the reciprocal value of this object as a new Rational.
+     *
      * @return the reciprocal in a new object
      */
+    @NotNull
     public Rational getReciprocal()
     {
-        return new Rational(this.denominator, this.numerator);
-    }
-
-    /**
-     * Checks if this rational number is an Integer, either positive or negative.
-     */
+        return new Rational(this._denominator, this._numerator);
+    }
+
+    /** Checks if this rational number is an Integer, either positive or negative. */
     public boolean isInteger()
     {
-        if (denominator == 1 ||
-                (denominator != 0 && (numerator % denominator == 0)) ||
-                (denominator == 0 && numerator == 0)
-        ) {
-            return true;
-        } else {
-            return false;
-        }
+        return _denominator == 1 ||
+                (_denominator != 0 && (_numerator % _denominator == 0)) ||
+                (_denominator == 0 && _numerator == 0);
     }
 
     /**
      * Returns a string representation of the object of form <code>numerator/denominator</code>.
-     * @return  a string representation of the object.
-     */
+     *
+     * @return a string representation of the object.
+     */
+    @NotNull
     public String toString()
     {
-        return numerator + "/" + denominator;
-    }
-
-    /**
-     * Returns the simplest represenation of this Rational's value possible.
-     */
+        return _numerator + "/" + _denominator;
+    }
+
+    /** Returns the simplest representation of this Rational's value possible. */
+    @NotNull
     public String toSimpleString(boolean allowDecimal)
     {
-        if (denominator == 0 && numerator != 0) {
+        if (_denominator == 0 && _numerator != 0) {
             return toString();
         } else if (isInteger()) {
             return Integer.toString(intValue());
-        } else if (numerator != 1 && denominator % numerator == 0) {
+        } else if (_numerator != 1 && _denominator % _numerator == 0) {
             // common factor between denominator and numerator
-            int newDenominator = denominator / numerator;
+            long newDenominator = _denominator / _numerator;
             return new Rational(1, newDenominator).toSimpleString(allowDecimal);
         } else {
@@ -220 +200 @@
      * Decides whether a brute-force simplification calculation should be avoided
      * by comparing the maximum number of possible calculations with some threshold.
+     *
      * @return true if the simplification should be performed, otherwise false
      */
     private boolean tooComplexForSimplification()
     {
-        double maxPossibleCalculations = (((double)(Math.min(denominator, numerator) - 1) / 5d) + 2);
+        double maxPossibleCalculations = (((double) (Math.min(_denominator, _numerator) - 1) / 5d) + 2);
+        final int maxSimplificationCalculations = 1000;
         return maxPossibleCalculations > maxSimplificationCalculations;
     }
@@ -231 +213 @@
      * Compares two <code>Rational</code> instances, returning true if they are mathematically
      * equivalent.
+     *
      * @param obj the Rational to compare this instance to.
      * @return true if instances are mathematically equivalent, otherwise false.  Will also
      *         return false if <code>obj</code> is not an instance of <code>Rational</code>.
      */
-    public boolean equals(Object obj)
-    {
-        if (!(obj instanceof Rational)) {
+    @Override
+    public boolean equals(@Nullable Object obj)
+    {
+        if (obj==null || !(obj instanceof Rational))
             return false;
-        }
-        Rational that = (Rational)obj;
+        Rational that = (Rational) obj;
         return this.doubleValue() == that.doubleValue();
+    }
+
+    @Override
+    public int hashCode()
+    {
+        return (23 * (int)_denominator) + (int)_numerator;
     }
 
@@ -252 +241 @@
      * To reduce a rational, need to see if both numerator and denominator are divisible
      * by a common factor.  Using the prime number series in ascending order guarantees
-     * the minimun number of checks required.</p>
+     * the minimum number of checks required.</p>
      * <p>
      * However, generating the prime number series seems to be a hefty task.  Perhaps
@@ -265 +254 @@
      *   -- * ------------------------------------ + 2
      *   10                    2
-     *
+     * <p/>
      *   Math.min(denominator, numerator) - 1
      * = ------------------------------------ + 2
      *                  5
      * </pre></code>
-     * @return a simplified instance, or if the Rational could not be simpliffied,
+     *
+     * @return a simplified instance, or if the Rational could not be simplified,
      *         returns itself (unchanged)
      */
+    @NotNull
     public Rational getSimplifiedInstance()
     {
@@ -278 +269 @@
             return this;
         }
-        for (int factor = 2; factor <= Math.min(denominator, numerator); factor++) {
+        for (int factor = 2; factor <= Math.min(_denominator, _numerator); factor++) {
             if ((factor % 2 == 0 && factor > 2) || (factor % 5 == 0 && factor > 5)) {
                 continue;
             }
-            if (denominator % factor == 0 && numerator % factor == 0) {
+            if (_denominator % factor == 0 && _numerator % factor == 0) {
                 // found a common factor
-                return new Rational(numerator / factor, denominator / factor);
+                return new Rational(_numerator / factor, _denominator / factor);
             }
         }