You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sis.apache.org by de...@apache.org on 2012/10/20 07:56:02 UTC

svn commit: r1400376 - in /sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis: internal/util/ math/ util/ util/collection/ util/logging/ util/resources/ xml/

Author: desruisseaux
Date: Sat Oct 20 05:56:01 2012
New Revision: 1400376

URL: http://svn.apache.org/viewvc?rev=1400376&view=rev
Log:
Consistent indentation of notes.

Modified:
    sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/util/ReferenceQueueConsumer.java
    sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/math/MathFunctions.java
    sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/CharSequences.java
    sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/Workaround.java
    sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/CheckedArrayList.java
    sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/CheckedHashMap.java
    sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/CheckedHashSet.java
    sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/logging/Logging.java
    sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/logging/PerformanceLevel.java
    sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/resources/package-info.java
    sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/XLink.java

Modified: sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/util/ReferenceQueueConsumer.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/util/ReferenceQueueConsumer.java?rev=1400376&r1=1400375&r2=1400376&view=diff
==============================================================================
--- sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/util/ReferenceQueueConsumer.java (original)
+++ sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/internal/util/ReferenceQueueConsumer.java Sat Oct 20 05:56:01 2012
@@ -80,8 +80,8 @@ public final class ReferenceQueueConsume
      * It will run only only a few nanoseconds every time a new {@link Reference} is enqueued.
      *
      * {@note We give to this thread a priority higher than the normal one since this thread shall
-     * execute only tasks to be completed very shortly. Quick execution of those tasks is at the
-     * benefit of the rest of the system, since they make more resources available sooner.}
+     *        execute only tasks to be completed very shortly. Quick execution of those tasks is at
+     *        the benefit of the rest of the system, since they make more resources available sooner.}
      */
     private ReferenceQueueConsumer(final DaemonThread lastCreatedDaemon) {
         super(Threads.DAEMONS, "ReferenceQueueConsumer", lastCreatedDaemon);

Modified: sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/math/MathFunctions.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/math/MathFunctions.java?rev=1400376&r1=1400375&r2=1400376&view=diff
==============================================================================
--- sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/math/MathFunctions.java (original)
+++ sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/math/MathFunctions.java Sat Oct 20 05:56:01 2012
@@ -122,8 +122,8 @@ public final class MathFunctions extends
      * change in any future Apache SIS version.
      *
      * {@note The current value is the highest prime number representable as an unsigned 16 bits
-     * integer. This is enough for current needs because 16 bits prime numbers are sufficient for
-     * finding the divisors of any 32 bits integers.}
+     *        integer. This is enough for current needs because 16 bits prime numbers are sufficient
+     *        for finding the divisors of any 32 bits integers.}
      *
      * @see #nextPrimeNumber(int)
      */
@@ -228,10 +228,11 @@ public final class MathFunctions extends
      * sometime at the cost of performance.
      *
      * {@note This method has been defined because the standard <code>Math.pow(10, x)</code>
-     * method does not always return the closest IEEE floating point representation. Slight
-     * departures (1 or 2 ULP) are often allowed in math functions for performance reasons.
-     * The most accurate calculations are usually not necessary, but the base 10 is a special
-     * case since it is used for scaling axes or formatting human-readable output.}
+     *        method does not always return the closest IEEE floating point representation.
+     *        Slight departures (1 or 2 ULP) are often allowed in math functions for performance
+     *        reasons. The most accurate calculations are usually not necessary, but the base 10
+     *        is a special case since it is used for scaling axes or formatting human-readable
+     *        output.}
      *
      * @param x The exponent.
      * @return 10 raised to the given exponent.

Modified: sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/CharSequences.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/CharSequences.java?rev=1400376&r1=1400375&r2=1400376&view=diff
==============================================================================
--- sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/CharSequences.java (original)
+++ sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/CharSequences.java Sat Oct 20 05:56:01 2012
@@ -423,11 +423,12 @@ search:     for (; fromIndex <= stopAt; 
      * this method does not remove whitespaces.</p>
      *
      * {@note Prior JDK8 this method was relatively cheap because all string instances created by
-     * <code>String.substring(int,int)</code> shared the same <code>char[]</code> internal array.
-     * However since JDK8, the new <code>String</code> implementation copies the data in new arrays.
-     * Consequently it is better to use index rather than this method for splitting large
-     * <code>String</code>s. However this method still useful for other <code>CharSequence</code>
-     * implementations providing an efficient <code>subSequence(int,int)</code> method.}
+     *        <code>String.substring(int,int)</code> shared the same <code>char[]</code> internal
+     *        array. However since JDK8, the new <code>String</code> implementation copies the data
+     *        in new arrays. Consequently it is better to use index rather than this method for
+     *        splitting large <code>String</code>s. However this method still useful for other
+     *        <code>CharSequence</code> implementations providing an efficient
+     *        <code>subSequence(int,int)</code> method.}
      *
      * @param  text The multi-line text from which to get the individual lines, or {@code null}.
      * @return The lines in the text, or an empty array if the given text was null.

Modified: sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/Workaround.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/Workaround.java?rev=1400376&r1=1400375&r2=1400376&view=diff
==============================================================================
--- sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/Workaround.java (original)
+++ sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/Workaround.java Sat Oct 20 05:56:01 2012
@@ -27,9 +27,9 @@ import java.lang.annotation.RetentionPol
  * This is marker annotation for source code only, in order to keep trace of code to revisit
  * when new versions of external libraries become available.
  *
- * {@note When only a portion of a method contains a workaround and the annotation can not be
- * applied to that specific part, than it is applied to the whole method. Developers need to
- * refer to code comments in order to locate the specific part.}
+ * {@note When only a portion of a method contains a workaround and the annotation can
+ *        not be applied to that specific part, than it is applied to the whole method.
+ *        Developers need to refer to code comments in order to locate the specific part.}
  *
  * @author  Martin Desruisseaux (Geomatys)
  * @since   0.3 (derived from geotk-3.15)

Modified: sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/CheckedArrayList.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/CheckedArrayList.java?rev=1400376&r1=1400375&r2=1400376&view=diff
==============================================================================
--- sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/CheckedArrayList.java (original)
+++ sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/CheckedArrayList.java Sat Oct 20 05:56:01 2012
@@ -52,7 +52,7 @@ import static org.apache.sis.util.Argume
  * For real concurrency, see the {@link java.util.concurrent} package instead.
  *
  * {@note The above is the reason why the name of this class emphases the <cite>checked</cite>
- * aspect rather than the <cite>synchronized</cite> aspect of the list.}
+ *        aspect rather than the <cite>synchronized</cite> aspect of the list.}
  *
  * @param <E> The type of elements in the list.
  *

Modified: sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/CheckedHashMap.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/CheckedHashMap.java?rev=1400376&r1=1400375&r2=1400376&view=diff
==============================================================================
--- sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/CheckedHashMap.java (original)
+++ sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/CheckedHashMap.java Sat Oct 20 05:56:01 2012
@@ -51,7 +51,7 @@ import static org.apache.sis.util.Argume
  * For real concurrency, see the {@link java.util.concurrent} package instead.
  *
  * {@note The above is the reason why the name of this class emphases the <cite>checked</cite>
- * aspect rather than the <cite>synchronized</cite> aspect of the map.}
+ *        aspect rather than the <cite>synchronized</cite> aspect of the map.}
  *
  * @param <K> The type of keys in the map.
  * @param <V> The type of values in the map.
@@ -119,9 +119,9 @@ public class CheckedHashMap<K,V> extends
      * be modified. Subclasses can override this method if they want to control write permissions.</p>
      *
      * {@note Actually the current implementation contains an <code>assert</code> statement
-     * ensuring that the thread holds the lock. This is an implementation details that may
-     * change in any future version of the SIS library. Nevertheless methods that override
-     * this one are encouraged to invoke <code>super.checkWritePermission()</code>.}
+     *        ensuring that the thread holds the lock. This is an implementation details that may
+     *        change in any future version of the SIS library. Nevertheless methods that override
+     *        this one are encouraged to invoke <code>super.checkWritePermission()</code>.}
      *
      * @throws UnsupportedOperationException if this map is unmodifiable.
      */

Modified: sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/CheckedHashSet.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/CheckedHashSet.java?rev=1400376&r1=1400375&r2=1400376&view=diff
==============================================================================
--- sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/CheckedHashSet.java (original)
+++ sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/collection/CheckedHashSet.java Sat Oct 20 05:56:01 2012
@@ -51,7 +51,7 @@ import static org.apache.sis.util.Argume
  * For real concurrency, see the {@link java.util.concurrent} package instead.
  *
  * {@note The above is the reason why the name of this class emphases the <cite>checked</cite>
- * aspect rather than the <cite>synchronized</cite> aspect of the set.}
+ *        aspect rather than the <cite>synchronized</cite> aspect of the set.}
  *
  * @param <E> The type of elements in the set.
  *
@@ -144,9 +144,9 @@ public class CheckedHashSet<E> extends L
      * be modified. Subclasses can override this method if they want to control write permissions.</p>
      *
      * {@note Actually the current implementation contains an <code>assert</code> statement
-     * ensuring that the thread holds the lock. This is an implementation details that may
-     * change in any future version of the SIS library. Nevertheless methods that override
-     * this one are encouraged to invoke <code>super.checkWritePermission()</code>.}
+     *        ensuring that the thread holds the lock. This is an implementation details that may
+     *        change in any future version of the SIS library. Nevertheless methods that override
+     *        this one are encouraged to invoke <code>super.checkWritePermission()</code>.}
      *
      * @throws UnsupportedOperationException if this set is unmodifiable.
      */

Modified: sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/logging/Logging.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/logging/Logging.java?rev=1400376&r1=1400375&r2=1400376&view=diff
==============================================================================
--- sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/logging/Logging.java (original)
+++ sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/logging/Logging.java Sat Oct 20 05:56:01 2012
@@ -97,8 +97,9 @@ public final class Logging extends Stati
      * The children {@link Logging} objects.
      *
      * {@note The array used there is not efficient for adding new items (<code>ArrayList</code>
-     * would be more efficient), but we assume that very few new items will be added. Furthermore
-     * a plain array is efficient for reading, and the later is way more common than the former.}
+     *        would be more efficient), but we assume that very few new items will be added.
+     *        Furthermore a plain array is efficient for reading, and the later is way more
+     *        common than the former.}
      */
     private Logging[] children = EMPTY;
 

Modified: sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/logging/PerformanceLevel.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/logging/PerformanceLevel.java?rev=1400376&r1=1400375&r2=1400376&view=diff
==============================================================================
--- sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/logging/PerformanceLevel.java (original)
+++ sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/logging/PerformanceLevel.java Sat Oct 20 05:56:01 2012
@@ -148,8 +148,8 @@ public final class PerformanceLevel exte
      * </ul>
      *
      * {@note The duration of the <code>PERFORMANCE</code> level can not be modified: it is
-     * always zero. However invoking this method on the <code>PERFORMANCE</code> field will
-     * ensure that every <code>SLOW*</code> levels will have at least the given duration.}
+     *        always zero. However invoking this method on the <code>PERFORMANCE</code> field will
+     *        ensure that every <code>SLOW*</code> levels will have at least the given duration.}
      *
      * @param  duration The minimal duration.
      * @param  unit The unit of the given duration value.

Modified: sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/resources/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/resources/package-info.java?rev=1400376&r1=1400375&r2=1400376&view=diff
==============================================================================
--- sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/resources/package-info.java (original)
+++ sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/util/resources/package-info.java Sat Oct 20 05:56:01 2012
@@ -32,14 +32,14 @@
  * </ul>
  *
  * {@note <code>java.util.Formatter</code> is an alternative to <code>MessageFormat</code> providing
- * similar functionalities with a C/C++ like syntax. However <code>MessageFormat</code> has two
- * advantages: it provides a <code>choice</code> format type (useful for handling plural forms),
- * and localizes properly objects of unspecified type (by contrast, the <code>Formatter</code>
- * <code>"%s"</code> type always invoke <code>toString()</code>). The later advantage is
- * important for messages in wich the same argument could receive <code>Number</code> or
- * <code>Date</code> instances as well as <code>String</code>.
- * Furthermore, the <code>java.util.logging</code> framework is designed for use with
- * <code>MessageFormat</code> (see the <code>Formatter.formatMessage(LogRecord)</code> method).}
+ *        similar functionalities with a C/C++ like syntax. However <code>MessageFormat</code> has two
+ *        advantages: it provides a <code>choice</code> format type (useful for handling plural forms),
+ *        and localizes properly objects of unspecified type (by contrast, the <code>Formatter</code>
+ *        <code>"%s"</code> type always invoke <code>toString()</code>). The later advantage is
+ *        important for messages in wich the same argument could receive <code>Number</code> or
+ *        <code>Date</code> instances as well as <code>String</code>.
+ *        Furthermore, the <code>java.util.logging</code> framework is designed for use with
+ *        <code>MessageFormat</code> (see the <code>Formatter.formatMessage(LogRecord)</code> method).}
  *
  * Apache SIS developers can add resources by editing the {@code *.properties} file
  * in the source code directory, then run the localized resources compiler provided in the

Modified: sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/XLink.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/XLink.java?rev=1400376&r1=1400375&r2=1400376&view=diff
==============================================================================
--- sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/XLink.java (original)
+++ sis/branches/JDK7/sis-utility/src/main/java/org/apache/sis/xml/XLink.java Sat Oct 20 05:56:01 2012
@@ -440,8 +440,8 @@ public class XLink implements Serializab
      * identifier.
      *
      * {@note This serves a role similar to <code>idref</code>. The <code>idref</code>
-     * attribute allows an XML element to refer to another XML element that has a
-     * corresponding <code>id</code> attribute.}
+     *        attribute allows an XML element to refer to another XML element that has
+     *        a corresponding <code>id</code> attribute.}
      *
      * @return A URN to a resources, or {@code null} if none.
      *