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 2017/01/17 07:30:59 UTC
svn commit: r1779147 - in
/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal:
converter/ simple/ system/ util/
Author: desruisseaux
Date: Tue Jan 17 07:30:59 2017
New Revision: 1779147
URL: http://svn.apache.org/viewvc?rev=1779147&view=rev
Log:
More partially automatized javadoc formatting.
Modified:
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/converter/StringConverter.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleAttributeType.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/DaemonThread.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/DataDirectory.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/DelayedExecutor.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/LocalizedStaticObject.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Loggers.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/OS.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/OSGiActivator.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/OptionalDependency.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/ReferenceQueueConsumer.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Semaphores.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/ServletListener.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Shutdown.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Supervisor.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/SupervisorMBean.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/SystemListener.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/AbstractMapEntry.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/CheckedArrayList.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/CheckedHashSet.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/DefinitionURI.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/DoubleDouble.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/LazySet.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/LazySynchronizedIterator.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/MetadataServices.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/SetOfUnknownSize.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/StandardDateFormat.java
sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/X364.java
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/converter/StringConverter.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/converter/StringConverter.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/converter/StringConverter.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/converter/StringConverter.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -123,7 +123,7 @@ abstract class StringConverter<T> extend
* then delegates to {@link #doConvert(String)}.
*
* @param source the string to convert, or {@code null}.
- * @return The converted value, or {@code null} if the given string was null or empty.
+ * @return the converted value, or {@code null} if the given string was null or empty.
* @throws UnconvertibleObjectException if an error occurred during the conversion.
*/
@Override
@@ -146,7 +146,7 @@ abstract class StringConverter<T> extend
* type of this converter.
*
* @param source the string to convert, guaranteed to be non-null and non-empty.
- * @return The converted value.
+ * @return the converted value.
* @throws Exception if an error occurred during the conversion.
*/
abstract T doConvert(String source) throws Exception;
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleAttributeType.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleAttributeType.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleAttributeType.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/simple/SimpleAttributeType.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -149,7 +149,7 @@ public final class SimpleAttributeType<V
/**
* Not used for this simple attribute type.
*
- * @return Always {@code null}.
+ * @return always {@code null}.
*/
@Override
public InternationalString getDescription() {
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/DaemonThread.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/DaemonThread.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/DaemonThread.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/DaemonThread.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -83,9 +83,9 @@ abstract class DaemonThread extends Thre
*
* See {@link ReferenceQueueConsumer} for a real example.
*
- * @param name The thread name.
- * @param lastCreatedDaemon The previous element in a chain of {@code DaemonThread}s,
- * or {@code null}. Each SIS module shall maintain its own chain, if any.
+ * @param name the thread name.
+ * @param lastCreatedDaemon the previous element in a chain of {@code DaemonThread}s, or {@code null}.
+ * Each SIS module shall maintain its own chain, if any.
*/
protected DaemonThread(final String name, final DaemonThread lastCreatedDaemon) {
super(Threads.DAEMONS, name);
@@ -128,10 +128,10 @@ abstract class DaemonThread extends Thre
* <p><strong>This method is for internal use by Apache SIS shutdown hooks only.</strong>
* Users should never invoke this method explicitely.</p>
*
- * @param thread The first thread in the chain of threads to kill.
- * @param stopWaitingAt A {@link System#nanoTime()} value telling when to stop waiting.
+ * @param thread the first thread in the chain of threads to kill.
+ * @param stopWaitingAt a {@link System#nanoTime()} value telling when to stop waiting.
* This is used for preventing shutdown process to block an indefinite amount of time.
- * @throws InterruptedException If an other thread invoked {@link #interrupt()} while
+ * @throws InterruptedException if an other thread invoked {@link #interrupt()} while
* we were waiting for the daemon threads to die.
*
* @see Threads#shutdown(long)
@@ -144,7 +144,7 @@ abstract class DaemonThread extends Thre
while (thread != null) {
final long delay = stopWaitingAt - System.nanoTime();
if (delay <= 0) break;
- thread.join(delay / 1000000); // Convert nanoseconds to milliseconds.
+ thread.join(delay / 1000000); // Convert nanoseconds to milliseconds.
thread = thread.previous;
}
}
@@ -157,8 +157,8 @@ abstract class DaemonThread extends Thre
* <p><strong>This method is for internal use by Apache SIS only.</strong>
* Users should never invoke this method explicitely.</p>
*
- * @param thread The first thread in the chain of threads to verify.
- * @return The list of stalled or dead threads, or {@code null} if none.
+ * @param thread the first thread in the chain of threads to verify.
+ * @return the list of stalled or dead threads, or {@code null} if none.
*/
static List<Thread> listStalledThreads(DaemonThread thread) {
List<Thread> list = null;
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/DataDirectory.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/DataDirectory.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/DataDirectory.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/DataDirectory.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -111,7 +111,7 @@ public enum DataDirectory {
* Returns the root directory fetched from the {@code SIS_DATA} environment variable.
* If the environment variable is not set or the directory does not exist, then this method returns {@code null}.
*
- * @return The root SIS data directory, or {@code null} if none.
+ * @return the root SIS data directory, or {@code null} if none.
*/
public static synchronized Path getRootDirectory() {
if (rootDirectory == null) try {
@@ -142,7 +142,7 @@ public enum DataDirectory {
* directory was not specified. If the {@code $SIS_DATA} directory exists but not the sub-directory,
* then this method creates the sub-directory.
*
- * @return The sub-directory, or {@code null} if unspecified.
+ * @return the sub-directory, or {@code null} if unspecified.
*/
public synchronized Path getDirectory() {
if (directory == null) {
@@ -180,7 +180,7 @@ public enum DataDirectory {
* path is returned as-is.
*
* @param file The path to resolve, or {@code null}.
- * @return The path to use, or {@code null} if the given path was null.
+ * @return the path to use, or {@code null} if the given path was null.
*/
public Path resolve(Path file) {
if (file != null && !file.isAbsolute()) {
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/DelayedExecutor.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/DelayedExecutor.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/DelayedExecutor.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/DelayedExecutor.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -82,8 +82,10 @@ public final class DelayedExecutor exten
synchronized (Threads.class) {
final DelayedExecutor thread;
Threads.lastCreatedDaemon = thread = new DelayedExecutor(Threads.lastCreatedDaemon);
- // Call to Thread.start() must be outside the constructor
- // (Reference: Goetz et al.: "Java Concurrency in Practice").
+ /*
+ * Call to Thread.start() must be outside the constructor
+ * (Reference: Goetz et al.: "Java Concurrency in Practice").
+ */
thread.start();
}
if (Supervisor.ENABLED) {
@@ -125,8 +127,10 @@ public final class DelayedExecutor exten
continue;
}
} catch (InterruptedException exception) {
- // Probably the 'killAll' method has been invoked.
- // We need to test 'isKillRequested()' below.
+ /*
+ * Probably the 'killAll' method has been invoked.
+ * We need to test 'isKillRequested()' below.
+ */
} catch (Throwable exception) {
Logging.unexpectedException(Logging.getLogger(Loggers.SYSTEM), getClass(), "run", exception);
}
@@ -158,8 +162,10 @@ public final class DelayedExecutor exten
}
return true;
} catch (InterruptedException e) {
- // Someone doesn't want to let us wait. Since we didn't had the time to
- // determine if the thread is stalled, conservatively return 'false'.
+ /*
+ * Someone doesn't want to let us wait. Since we didn't had the time to
+ * determine if the thread is stalled, conservatively return 'false'.
+ */
}
return false;
}
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/LocalizedStaticObject.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/LocalizedStaticObject.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/LocalizedStaticObject.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/LocalizedStaticObject.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -23,9 +23,9 @@ import java.lang.annotation.RetentionPol
/**
- * Annotates a static object using the {@linkplain java.util.Locale#getDefault() default locale}
- * and {@linkplain java.util.TimeZone#getDefault() default timezone} values which existed at the
- * object creation time.
+ * Annotates a static object created using the {@linkplain java.util.Locale#getDefault() default locale}
+ * and {@linkplain java.util.TimeZone#getDefault() default timezone} values which existed at the object
+ * creation time.
*
* If JDK provided listeners allowing SIS to be notified about locale and timezone changes, we would
* reset the annotated object to {@code null}. However since those listeners do not exist as of JDK7,
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Loggers.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Loggers.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Loggers.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Loggers.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -128,7 +128,7 @@ public final class Loggers extends Stati
*
* <p>This method does not report the loggers that have an effective level identical to its parent logger.</p>
*
- * @return The effective logging levels of SIS loggers.
+ * @return the effective logging levels of SIS loggers.
*/
public static SortedMap<String,Level> getEffectiveLevels() {
final SortedMap<String,Level> levels = new TreeMap<>();
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/OS.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/OS.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/OS.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/OS.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -61,7 +61,7 @@ public enum OS {
/**
* Returns the operating system SIS is currently on.
*
- * @return The operation system.
+ * @return the operation system.
*/
public static OS current() {
final String name = System.getProperty("os.name");
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/OSGiActivator.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/OSGiActivator.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/OSGiActivator.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/OSGiActivator.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -44,7 +44,7 @@ public final class OSGiActivator impleme
/**
* Invoked when this bundle is started.
*
- * @param context The execution context of the bundle being started.
+ * @param context the execution context of the bundle being started.
*/
@Override
public void start(final BundleContext context) {
@@ -56,8 +56,8 @@ public final class OSGiActivator impleme
* Invoked when this bundle is stopped.
* This method shutdowns the {@code sis-utility} threads.
*
- * @param context The execution context of the bundle being stopped.
- * @throws Exception If an error occurred during unregistration of the supervisor MBean or resource disposal.
+ * @param context the execution context of the bundle being stopped.
+ * @throws Exception if an error occurred during unregistration of the supervisor MBean or resource disposal.
*/
@Override
public void stop(final BundleContext context) throws Exception {
@@ -69,7 +69,7 @@ public final class OSGiActivator impleme
* Invoked when an other module has been installed or un-installed.
* This method notifies the Apache SIS library that the classpath may have changed.
*
- * @param event The event that describe the life-cycle change.
+ * @param event the event that describe the life-cycle change.
*/
@Override
public void bundleChanged(final BundleEvent event) {
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/OptionalDependency.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/OptionalDependency.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/OptionalDependency.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/OptionalDependency.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -42,8 +42,8 @@ public abstract class OptionalDependency
/**
* Creates a new optional dependency.
*
- * @param module A constant from the {@link Modules} class which identify the module that need the optional dependency.
- * @param dependency The Maven artifact name (<strong>not</strong> a name from the {@link Modules} class)
+ * @param module a constant from the {@link Modules} class which identify the module that need the optional dependency.
+ * @param dependency the Maven artifact name (<strong>not</strong> a name from the {@link Modules} class)
* of the optional module on which the {@code module} depend.
*/
protected OptionalDependency(final String module, final String dependency) {
@@ -75,12 +75,12 @@ public abstract class OptionalDependency
* Returns the optional dependency, or {@code null} if not found.
* This is a helper method for implementation of {@code getInstance()} static method in subclasses.
*
- * @param <T> Compile-time type of the {@code type} argument.
- * @param type The subclass type.
- * @param module Same argument value than the one given to the {@linkplain #OptionalDependency constructor}.
- * @param dependency Same argument value than the one given to the {@linkplain #OptionalDependency constructor}.
- * @param implementation The fully-qualified name of the class to instantiate by reflection.
- * @return An instance of the {@code implementation} class, or {@code null} if not found.
+ * @param <T> compile-time type of the {@code type} argument.
+ * @param type the subclass type.
+ * @param module same argument value than the one given to the {@linkplain #OptionalDependency constructor}.
+ * @param dependency same argument value than the one given to the {@linkplain #OptionalDependency constructor}.
+ * @param implementation the fully-qualified name of the class to instantiate by reflection.
+ * @return an instance of the {@code implementation} class, or {@code null} if not found.
*/
protected static <T extends OptionalDependency> T getInstance(final Class<T> type,
final String module, final String dependency, final String implementation)
@@ -103,7 +103,7 @@ public abstract class OptionalDependency
* Returns the exception to throw when a method requiring the optional dependency is invoked
* but that module is not on the classpath.
*
- * @return The exception to throw.
+ * @return the exception to throw.
*/
protected final UnsupportedOperationException moduleNotFound() {
return new UnsupportedOperationException(Errors.format(Errors.Keys.MissingRequiredModule_1, dependency));
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/ReferenceQueueConsumer.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/ReferenceQueueConsumer.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/ReferenceQueueConsumer.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/ReferenceQueueConsumer.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -65,8 +65,10 @@ public final class ReferenceQueueConsume
synchronized (Threads.class) {
final ReferenceQueueConsumer thread;
Threads.lastCreatedDaemon = thread = new ReferenceQueueConsumer(Threads.lastCreatedDaemon);
- // Call to Thread.start() must be outside the constructor
- // (Reference: Goetz et al.: "Java Concurrency in Practice").
+ /*
+ * Call to Thread.start() must be outside the constructor
+ * (Reference: Goetz et al.: "Java Concurrency in Practice").
+ */
thread.start();
}
if (Supervisor.ENABLED) {
@@ -120,8 +122,10 @@ public final class ReferenceQueueConsume
continue;
}
} catch (InterruptedException exception) {
- // Probably the 'killAll' method has been invoked.
- // We need to test 'isKillRequested()' below.
+ /*
+ * Probably the 'killAll' method has been invoked.
+ * We need to test 'isKillRequested()' below.
+ */
} catch (Throwable exception) {
Logging.unexpectedException(Logging.getLogger(Loggers.SYSTEM), getClass(), "run", exception);
}
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Semaphores.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Semaphores.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Semaphores.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Semaphores.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -112,7 +112,7 @@ public final class Semaphores {
/**
* Clears the given flag.
*
- * @param flag one of {@link #CONVERSION_AND_CRS}, {@link #ENCLOSED_IN_OPERATION} or other constants.
+ * @param flag one of {@link #CONVERSION_AND_CRS}, {@link #ENCLOSED_IN_OPERATION} or other constants.
*/
public static void clear(final byte flag) {
final Semaphores s = FLAGS.get();
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/ServletListener.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/ServletListener.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/ServletListener.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/ServletListener.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -37,7 +37,7 @@ public final class ServletListener imple
/**
* Receives notification that the web application initialization process is starting.
*
- * @param event The context of the servlet being initialized.
+ * @param event the context of the servlet being initialized.
*/
@Override
public void contextInitialized(final ServletContextEvent event) {
@@ -48,7 +48,7 @@ public final class ServletListener imple
/**
* Receives notification that the application is about to be shutdown.
*
- * @param event The context of the servlet being shutdown.
+ * @param event the context of the servlet being shutdown.
*/
@Override
public void contextDestroyed(final ServletContextEvent event) {
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Shutdown.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Shutdown.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Shutdown.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Shutdown.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -18,12 +18,10 @@ package org.apache.sis.internal.system;
import java.util.List;
import java.util.ArrayList;
+import java.util.Objects;
import java.util.concurrent.Callable;
import org.apache.sis.util.logging.Logging;
-// Branch-dependent imports
-import java.util.Objects;
-
/**
* A central place where to manage SIS shutdown process.
@@ -78,7 +76,7 @@ public final class Shutdown extends Thre
/**
* Returns the value set by the last call to {@link #setContainer(String)}.
*
- * @return Typically {@code "OSGi"}, {@code "Servlet"} or {@code null}.
+ * @return typically {@code "OSGi"}, {@code "Servlet"} or {@code null}.
*/
public static String getContainer() {
synchronized (resources) {
@@ -91,8 +89,8 @@ public final class Shutdown extends Thre
* Example of such environments are OSG and servlet containers. In such case, the shutdown hook will not
* be registered to the JVM {@link Runtime}.
*
- * @param env A description of the container. Should contain version information if possible.
- * Example: {@code "OSGi"} or {@code "JavaServer Web Dev Kit/1.0"}.
+ * @param env a description of the container. Should contain version information if possible.
+ * Example: {@code "OSGi"} or {@code "JavaServer Web Dev Kit/1.0"}.
*/
public static void setContainer(final String env) {
Objects.requireNonNull(env);
@@ -108,7 +106,7 @@ public final class Shutdown extends Thre
*
* <p>The same resource shall not be added twice.</p>
*
- * @param resource The resource disposal to register for execution at shutdown time.
+ * @param resource the resource disposal to register for execution at shutdown time.
*/
public static void register(final Callable<?> resource) {
synchronized (resources) {
@@ -136,7 +134,7 @@ public final class Shutdown extends Thre
* Unregisters a code from execution at JVM shutdown time.
* This method uses identity comparison (it does not use {@link Object#equals(Object)}).
*
- * @param resource The resource disposal to cancel execution.
+ * @param resource the resource disposal to cancel execution.
*/
public static void unregister(final Callable<?> resource) {
synchronized (resources) {
@@ -152,7 +150,7 @@ public final class Shutdown extends Thre
/**
* Unregisters the supervisor MBean, executes the disposal tasks and shutdowns the {@code sis-utility} threads.
*
- * @param caller The class invoking this method, to be used only for logging purpose, or {@code null}
+ * @param caller the class invoking this method, to be used only for logging purpose, or {@code null}
* if the logging system is not available anymore (i.e. the JVM itself is shutting down).
* @throws Exception if an error occurred during unregistration of the supervisor MBean
* or during a resource disposal.
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Supervisor.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Supervisor.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Supervisor.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Supervisor.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -111,7 +111,7 @@ public final class Supervisor extends St
* has not been previously successfully {@linkplain #register() registered}, or if it has
* already been unregistered.
*
- * @throws JMException If an error occurred during unregistration.
+ * @throws JMException if an error occurred during unregistration.
*/
static synchronized void unregister() throws JMException {
final ObjectName n = name;
@@ -126,7 +126,7 @@ public final class Supervisor extends St
/**
* Creates a new {@code Supervisor}.
*
- * @throws NotCompliantMBeanException Should never happen.
+ * @throws NotCompliantMBeanException should never happen.
*/
public Supervisor() throws NotCompliantMBeanException {
super(SupervisorMBean.class);
@@ -145,7 +145,7 @@ public final class Supervisor extends St
/**
* Returns the localized description for this MBean.
*
- * @return A localized description.
+ * @return a localized description.
*/
@Override
protected String getDescription(final MBeanInfo info) {
@@ -155,7 +155,7 @@ public final class Supervisor extends St
/**
* Returns the localized description for the given constructor, attribute or operation.
*
- * @return A localized description for the given attribute or operation.
+ * @return a localized description for the given attribute or operation.
*/
@Override
protected String getDescription(final MBeanFeatureInfo info) {
@@ -165,10 +165,10 @@ public final class Supervisor extends St
/**
* Returns the localized description for the given constructor parameter.
*
- * @param info The constructor.
- * @param param The constructor parameter.
- * @param sequence The parameter number (0 for the first parameter, 1 for the second, etc.)
- * @return A localized description for the specified constructor parameter.
+ * @param info the constructor.
+ * @param param the constructor parameter.
+ * @param sequence the parameter number (0 for the first parameter, 1 for the second, etc.)
+ * @return a localized description for the specified constructor parameter.
*/
@Override
protected String getDescription(MBeanConstructorInfo info, MBeanParameterInfo param, int sequence) {
@@ -178,10 +178,10 @@ public final class Supervisor extends St
/**
* Returns the name of the given constructor parameter.
*
- * @param info The constructor.
- * @param param The constructor parameter.
- * @param sequence The parameter number (0 for the first parameter, 1 for the second, etc.)
- * @return The name of the specified constructor parameter.
+ * @param info the constructor.
+ * @param param the constructor parameter.
+ * @param sequence the parameter number (0 for the first parameter, 1 for the second, etc.)
+ * @return the name of the specified constructor parameter.
*/
@Override
protected String getParameterName(MBeanConstructorInfo info, MBeanParameterInfo param, int sequence) {
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/SupervisorMBean.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/SupervisorMBean.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/SupervisorMBean.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/SupervisorMBean.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -39,10 +39,10 @@ public interface SupervisorMBean {
* Apache SIS version, Java version and operation system version; a "Classpath"
* section containing bootstrap, extension and user classpath, <i>etc</i>.
*
- * @param sections The section for which information are desired.
- * @param locale The locale to use for formatting the texts in the tree, or {@code null} for the default.
- * @param timezone The timezone to use for formatting the dates, or {@code null} for the default.
- * @return Configuration information, as a tree for grouping some configuration by sections.
+ * @param sections the section for which information are desired.
+ * @param locale the locale to use for formatting the texts in the tree, or {@code null} for the default.
+ * @param timezone the timezone to use for formatting the dates, or {@code null} for the default.
+ * @return configuration information, as a tree for grouping some configuration by sections.
*/
TreeTable configuration(EnumSet<About> sections, Locale locale, TimeZone timezone);
@@ -50,8 +50,8 @@ public interface SupervisorMBean {
* If there is something wrong with the current Apache SIS status,
* returns descriptions of the problems. Otherwise returns {@code null}.
*
- * @param locale The locale to use for reporting messages, or {@code null} for the default.
- * @return A description of a problems in the library, or {@code null} if none.
+ * @param locale the locale to use for reporting messages, or {@code null} for the default.
+ * @return a description of a problems in the library, or {@code null} if none.
*/
String[] warnings(Locale locale);
}
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/SystemListener.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/SystemListener.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/SystemListener.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/SystemListener.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -47,7 +47,7 @@ public abstract class SystemListener imp
/**
* Creates a new listener.
*
- * @param module The OSGi module symbolic name, as declared in the {@code Bundle-SymbolicName}
+ * @param module the OSGi module symbolic name, as declared in the {@code Bundle-SymbolicName}
* entry of the {@code META-INF/MANIFEST.MF} file. Shall be one of {@link Modules} constants.
*/
protected SystemListener(final String module) {
@@ -59,7 +59,7 @@ public abstract class SystemListener imp
* This method doesn't check if the given listener is already present in the array,
* unless assertions are enabled.
*
- * @param listener The listener to add. Can not be {@code null}.
+ * @param listener the listener to add. Can not be {@code null}.
*/
public static synchronized void add(final SystemListener listener) {
assert (listener != null) && !ArraysExt.contains(listeners, listener);
@@ -78,7 +78,7 @@ public abstract class SystemListener imp
* Only one occurrence should exist, but this method check all of them as
* a paranoiac check.`
*
- * @param listener The listener to remove.
+ * @param listener the listener to remove.
*/
public static synchronized void remove(final SystemListener listener) {
SystemListener[] list = listeners;
@@ -96,8 +96,8 @@ public abstract class SystemListener imp
* Removes all listeners for the module of the given name.
* This method is invoked by {@link OSGiActivator}.
*
- * @param name The name of the module for which to remove listeners, or {@code null} if the module
- * to uninstall does not have symbolic name (in which case it is probably not a SIS module).
+ * @param name the name of the module for which to remove listeners, or {@code null} if the module
+ * to uninstall does not have symbolic name (in which case it is probably not a SIS module).
*/
static synchronized void removeModule(final String name) {
if (name != null) {
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/AbstractMapEntry.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/AbstractMapEntry.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/AbstractMapEntry.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/AbstractMapEntry.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -17,20 +17,18 @@
package org.apache.sis.internal.util;
import java.util.Map;
+import java.util.Objects;
import org.apache.sis.util.Debug;
import org.apache.sis.util.CharSequences;
import org.apache.sis.util.resources.Errors;
-// Branch-dependent imports
-import java.util.Objects;
-
/**
* Provides default implementations of {@link #equals(Object)}, {@link #hashCode()} and {@link #toString()}
* for a map entry.
*
- * @param <K> The type of keys maintained by the map.
- * @param <V> The type of mapped values.
+ * @param <K> the type of keys maintained by the map.
+ * @param <V> the type of mapped values.
*
* @author Martin Desruisseaux (Geomatys)
* @since 0.5
@@ -49,8 +47,8 @@ public abstract class AbstractMapEntry<K
* The default implementation throws {@code UnsupportedOperationException}
* for the convenience of unmodifiable map implementations.
*
- * @param value The new value to be stored in this entry.
- * @return The previous value (may be {@code null}).
+ * @param value the new value to be stored in this entry.
+ * @return the previous value (may be {@code null}).
* @throws UnsupportedOperationException if this entry is unmodifiable.
*/
@Override
@@ -62,7 +60,7 @@ public abstract class AbstractMapEntry<K
* Compares the specified object with this entry for equality.
* Criterion are specified by the {@link Map.Entry} contract.
*
- * @param object The other object to compare with this entry.
+ * @param object the other object to compare with this entry.
*/
@Override
public boolean equals(final Object object) {
@@ -97,8 +95,8 @@ public abstract class AbstractMapEntry<K
/**
* Returns only the first line of the string representation of the given value.
*
- * @param value The value for which to get a string representation.
- * @return The first line of the string representation of the given value.
+ * @param value the value for which to get a string representation.
+ * @return the first line of the string representation of the given value.
*/
static String firstLine(final Object value) {
String s = String.valueOf(value);
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/CheckedArrayList.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/CheckedArrayList.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/CheckedArrayList.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/CheckedArrayList.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -46,7 +46,7 @@ import static org.apache.sis.util.Argume
* The checks are performed only on a <cite>best effort</cite> basis. In current implementation,
* holes are known to exist in use cases like {@code sublist(\u2026).set(\u2026)} or when using the list iterator.
*
- * @param <E> The type of elements in the list.
+ * @param <E> the type of elements in the list.
*
* @author Martin Desruisseaux (Geomatys)
* @since 0.3
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/CheckedHashSet.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/CheckedHashSet.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/CheckedHashSet.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/CheckedHashSet.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -37,7 +37,7 @@ import static org.apache.sis.util.Argume
* <li>Does not accept null elements.</li>
* </ul>
*
- * @param <E> The type of elements in the set.
+ * @param <E> the type of elements in the set.
*
* @author Martin Desruisseaux (Geomatys)
* @since 0.3
@@ -60,7 +60,7 @@ public final class CheckedHashSet<E> ext
/**
* Constructs a set of the specified type.
*
- * @param type The element type (can not be null).
+ * @param type the element type (can not be null).
*/
public CheckedHashSet(final Class<E> type) {
super();
@@ -71,8 +71,8 @@ public final class CheckedHashSet<E> ext
/**
* Constructs a set of the specified type and initial capacity.
*
- * @param type The element type (should not be null).
- * @param capacity The initial capacity.
+ * @param type the element type (should not be null).
+ * @param capacity the initial capacity.
*/
public CheckedHashSet(final Class<E> type, final int capacity) {
super(capacity);
@@ -91,7 +91,7 @@ public final class CheckedHashSet<E> ext
/**
* Adds the specified element to this set if it is not already present.
*
- * @param element element to be added to this set.
+ * @param element element to be added to this set.
* @return {@code true} if the set did not already contain the specified element.
* @throws IllegalArgumentException if the specified element is not of the expected type.
*/
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/DefinitionURI.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/DefinitionURI.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/DefinitionURI.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/DefinitionURI.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -18,8 +18,8 @@ package org.apache.sis.internal.util;
import java.util.Map;
import java.util.Collections;
-
import org.apache.sis.util.CharSequences;
+
import static org.apache.sis.util.CharSequences.*;
import static org.apache.sis.util.ArgumentChecks.ensureNonNull;
import static org.apache.sis.internal.util.Utilities.appendUnicodeIdentifier;
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/DoubleDouble.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/DoubleDouble.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/DoubleDouble.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/DoubleDouble.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -126,9 +126,11 @@ public final class DoubleDouble extends
* @see #errorForWellKnownValue(double)
*/
private static final double[] VALUES = {
- // Some of the following constants have more fraction digits than necessary. We declare the extra
- // digits for documentation purpose, and in order to have identical content than DoubleDoubleTest
- // so that a plain copy-and-paste can be performed between those two classes.
+ /*
+ * Some of the following constants have more fraction digits than necessary. We declare the extra
+ * digits for documentation purpose, and in order to have identical content than DoubleDoubleTest
+ * so that a plain copy-and-paste can be performed between those two classes.
+ */
0.000004848136811095359935899141023579480, // Arc-second to radians
0.0002777777777777777777777777777777778, // Second to degrees
0.002777777777777777777777777777777778, // 1/360�
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/LazySet.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/LazySet.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/LazySet.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/LazySet.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -41,7 +41,7 @@ import org.apache.sis.internal.system.De
*
* <p>This class is not thread-safe. Synchronization, if desired, shall be done by the caller.</p>
*
- * @param <E> the type of elements in the set.
+ * @param <E> the type of elements in the set.
*
* @author Martin Desruisseaux (IRD, Geomatys)
* @since 0.6
@@ -197,7 +197,7 @@ public class LazySet<E> extends SetOfUnk
* Caches a new element. Subclasses can override this method is they want to substitute the given value
* by another value.
*
- * @param element The element to add to the cache.
+ * @param element the element to add to the cache.
*/
protected void cache(final E element) {
if (numCached >= cachedElements.length) {
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/LazySynchronizedIterator.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/LazySynchronizedIterator.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/LazySynchronizedIterator.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/LazySynchronizedIterator.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -28,7 +28,7 @@ import java.util.Iterator;
* different threads can safely use their iterators concurrently even if the underlying {@code Iterable}s
* were not thread-safe, because of the synchronization on {@code Iterable<E>} instances.</p>
*
- * @param <E> The type of elements to be returned by the iterator.
+ * @param <E> the type of elements to be returned by the iterator.
*
* @author Martin Desruisseaux (Geomatys)
* @since 0.7
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/MetadataServices.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/MetadataServices.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/MetadataServices.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/MetadataServices.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -62,7 +62,7 @@ public class MetadataServices extends Op
/**
* Returns the singleton instance.
*
- * @return The singleton instance.
+ * @return the singleton instance.
*/
@SuppressWarnings("DoubleCheckedLocking")
public static MetadataServices getInstance() {
@@ -94,8 +94,8 @@ public class MetadataServices extends Op
* for which the two citations of interest are {@code "ISBN"} (International Standard Book Number) and
* {@code "ISSN"} (International Standard Serial Number) citation.
*
- * @param name The name of one of the citation constants defined in the {@code Citations} class.
- * @return The requested citation, or {@code null} if the {@code sis-metadata} module is not available.
+ * @param name the name of one of the citation constants defined in the {@code Citations} class.
+ * @return the requested citation, or {@code null} if the {@code sis-metadata} module is not available.
*/
public CitationConstant getCitationConstant(final String name) {
return null;
@@ -106,8 +106,8 @@ public class MetadataServices extends Op
* The metadata module will search in a database for information like a descriptive
* title, abbreviations, identifiers, URL to a web site, <i>etc</i>.
*
- * @param key The primary key of the desired citation.
- * @return The requested citation, or {@code null} if the {@code sis-metadata} module is not available.
+ * @param key the primary key of the desired citation.
+ * @return the requested citation, or {@code null} if the {@code sis-metadata} module is not available.
*/
public Citation createCitation(final String key) {
return null;
@@ -123,9 +123,9 @@ public class MetadataServices extends Op
* <li>{@code "DataSource"}: URL to the data source, or error message.</li>
* </ul>
*
- * @param key A key identifying the information to return.
- * @param locale Language to use if possible.
- * @return The information, or {@code null} if none.
+ * @param key a key identifying the information to return.
+ * @param locale language to use if possible.
+ * @return the information, or {@code null} if none.
*
* @see org.apache.sis.internal.metadata.ReferencingServices#getInformation(String)
*/
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/SetOfUnknownSize.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/SetOfUnknownSize.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/SetOfUnknownSize.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/SetOfUnknownSize.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -28,7 +28,7 @@ import org.apache.sis.util.ArraysExt;
* An alternative to {@code AbstractSet} for implementations having a costly {@link #size()} method.
* This class overrides some methods in a way that avoid or reduce calls to {@link #size()}.
*
- * @param <E> the type of elements in the set.
+ * @param <E> the type of elements in the set.
*
* @author Martin Desruisseaux (Geomatys)
* @since 0.7
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/StandardDateFormat.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/StandardDateFormat.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/StandardDateFormat.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/StandardDateFormat.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -143,8 +143,8 @@ public final class StandardDateFormat ex
* <li>Otherwise this method returns a {@link LocalDateTime} in the given timezone.</li>
* </ul>
*
- * @param date the date to convert, or {@code null}.
- * @param zone the timezone of the temporal object to obtain, or {@code null} for UTC.
+ * @param date the date to convert, or {@code null}.
+ * @param zone the timezone of the temporal object to obtain, or {@code null} for UTC.
* @return the temporal object for the given date, or {@code null} if the given argument was null.
*/
public static Temporal toHeuristicTemporal(final Date date, ZoneId zone) {
@@ -270,7 +270,7 @@ public final class StandardDateFormat ex
/**
* Sets the timezone.
*
- * @param zone the new timezone.
+ * @param zone the new timezone.
*/
@Override
public final void setTimeZone(final TimeZone zone) {
@@ -283,7 +283,7 @@ public final class StandardDateFormat ex
/**
* Overridden for compliance with {@code DateFormat} contract, but has no incidence on this format.
*
- * @param lenient value forwarded to {@link Calendar#setLenient(boolean)}.
+ * @param lenient value forwarded to {@link Calendar#setLenient(boolean)}.
*/
@Override
public final void setLenient(boolean lenient) {
@@ -374,7 +374,7 @@ public final class StandardDateFormat ex
/**
* Compares this format with the given object for equality.
*
- * @param obj the object to compare with this format.
+ * @param obj the object to compare with this format.
* @return if the two objects format in the same way.
*/
@Override
Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/X364.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/X364.java?rev=1779147&r1=1779146&r2=1779147&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/X364.java [UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/util/X364.java [UTF-8] Tue Jan 17 07:30:59 2017
@@ -119,8 +119,8 @@ public enum X364 {
/**
* Creates a new code.
*
- * @param code The X.364 numerical code.
- * @param color The color name, or {@code null} if none.
+ * @param code the X.364 numerical code.
+ * @param color the color name, or {@code null} if none.
*/
@SuppressWarnings("ThisEscapedInObjectConstruction")
private X364(final byte code, final String color) {
@@ -133,7 +133,7 @@ public enum X364 {
/**
* Creates a new background code.
*
- * @param foreground The X.364 code for a foreground color.
+ * @param foreground the X.364 code for a foreground color.
*/
@SuppressWarnings("ThisEscapedInObjectConstruction")
private X364(final X364 foreground) {
@@ -145,7 +145,7 @@ public enum X364 {
/**
* Returns the enum for the foreground color.
*
- * @return The foreground color, or {@code this} if this enum is already a foreground color.
+ * @return the foreground color, or {@code this} if this enum is already a foreground color.
*/
public X364 foreground() {
return foreground;
@@ -154,7 +154,7 @@ public enum X364 {
/**
* Returns the enum for the background color.
*
- * @return The background color, or {@code this} if this enum is already a background color.
+ * @return the background color, or {@code this} if this enum is already a background color.
*/
public X364 background() {
return background;
@@ -163,15 +163,17 @@ public enum X364 {
/**
* Returns the ANSI escape sequence.
*
- * @return The ANSI escape sequence.
+ * @return the ANSI escape sequence.
*/
public String sequence() {
if (sequence == null) {
sequence = (START + code + END).intern();
- // We used the string.intern() method in order to avoid worrying about memory barrier
- // (synchronization or volatile variable) since intern() does its own synchronization.
- // The String will live for the whole library lifetime anyway, and if there is other
- // X3.64 libraries on the JVM we may share the strings with them as a side effect.
+ /*
+ * We used the string.intern() method in order to avoid worrying about memory barrier
+ * (synchronization or volatile variable) since intern() does its own synchronization.
+ * The String will live for the whole library lifetime anyway, and if there is other
+ * X3.64 libraries on the JVM we may share the strings with them as a side effect.
+ */
}
return sequence;
}
@@ -179,10 +181,10 @@ public enum X364 {
/**
* Removes all escape codes from the given string.
*
- * @param text The string which may contains escape codes.
- * @param fromIndex The index from which to start the process.
- * @param toIndex The index after the last character to process.
- * @return Text without the escape codes, or the given {@code text} reference if
+ * @param text the string which may contains escape codes.
+ * @param fromIndex the index from which to start the process.
+ * @param toIndex the index after the last character to process.
+ * @return text without the escape codes, or the given {@code text} reference if
* it didn't contained any escape codes.
*/
public static CharSequence plain(final CharSequence text, int fromIndex, final int toIndex) {
@@ -221,10 +223,10 @@ search: do {
* CharSequences.codePointCount}({@linkplain #plain plain}(text))</code> without the
* cost of creating a temporary string.
*
- * @param text The string which may contains escape codes.
- * @param fromIndex The index from which to start the computation.
- * @param toIndex The index after the last character to take in account.
- * @return The length of the given string without escape codes.
+ * @param text the string which may contains escape codes.
+ * @param fromIndex the index from which to start the computation.
+ * @param toIndex the index after the last character to take in account.
+ * @return the length of the given string without escape codes.
*/
public static int lengthOfPlain(final CharSequence text, final int fromIndex, final int toIndex) {
int i = CharSequences.indexOf(text, START, fromIndex, toIndex);
@@ -243,11 +245,11 @@ search: do {
while (i < end) {
final char c = text.charAt(i++);
if (c < '0' || c > '9') {
- continue search; // Not an X.364 sequence.
+ continue search; // Not an X.364 sequence.
}
}
length += CharSequences.codePointCount(text, last, start);
- last = ++i; // The ++ is for skipping the END character.
+ last = ++i; // The ++ is for skipping the END character.
} while ((i = CharSequences.indexOf(text, START, i, toIndex)) >= 0);
length += CharSequences.codePointCount(text, last, toIndex);
assert CharSequences.codePointCount(plain(text, fromIndex, toIndex)) == length : text.subSequence(fromIndex, toIndex);
@@ -258,9 +260,9 @@ search: do {
* Returns the enumeration value for the given color name.
* The search is case-insensitive.
*
- * @param color The color name.
- * @return The code for the given color name.
- * @throws IllegalArgumentException If no code has been found for the given color name.
+ * @param color the color name.
+ * @return the code for the given color name.
+ * @throws IllegalArgumentException if no code has been found for the given color name.
*/
public static X364 forColorName(String color) throws IllegalArgumentException {
color = CharSequences.trimWhitespaces(color);
@@ -296,7 +298,7 @@ search: do {
}
terminal = System.getenv("CLICOLOR");
} catch (SecurityException e) {
- return false; // Okay according javadoc.
+ return false; // Okay according javadoc.
}
if (terminal != null) try {
return Integer.parseInt(terminal) != 0;