sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1770499 - in /sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis: internal/system/DelayedExecutor.java internal/system/DelayedRunnable.java internal/system/Threads.java xml/MarshallerPool.java
Date Sat, 19 Nov 2016 15:38:54 GMT
Author: desruisseaux
Date: Sat Nov 19 15:38:50 2016
New Revision: 1770499

URL: http://svn.apache.org/viewvc?rev=1770499&view=rev
Log:
Javadoc formatting.

Modified:
    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/DelayedRunnable.java
    sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Threads.java
    sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/xml/MarshallerPool.java

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=1770499&r1=1770498&r2=1770499&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] Sat Nov 19 15:38:50 2016
@@ -64,7 +64,7 @@ public final class DelayedExecutor exten
      * The task must completes quickly, because we will typically use only one thread for
all submitted tasks.
      * Completion of the task shall not be critical, since the JVM is allowed to shutdown
before task completion.
      *
-     * @param task The task to schedule for later execution.
+     * @param  task  the task to schedule for later execution.
      */
     public static void schedule(final DelayedRunnable task) {
         QUEUE.add(task);

Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/DelayedRunnable.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/DelayedRunnable.java?rev=1770499&r1=1770498&r2=1770499&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/DelayedRunnable.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/DelayedRunnable.java
[UTF-8] Sat Nov 19 15:38:50 2016
@@ -53,7 +53,7 @@ public abstract class DelayedRunnable im
      * It is user's responsibility to add the {@link System#nanoTime()} value
      * to the delay he wants to wait.
      *
-     * @param timestamp Time of execution of this task, in nanoseconds relative to {@link
System#nanoTime()}.
+     * @param timestamp  time of execution of this task, in nanoseconds relative to {@link
System#nanoTime()}.
      */
     protected DelayedRunnable(final long timestamp) {
         this.timestamp = timestamp;
@@ -74,7 +74,7 @@ public abstract class DelayedRunnable im
      * This restriction should be okay since the {@link DelayedExecutor} queue
      * accepts only {@code DelayedRunnable} instances.
      *
-     * @param other The other delayed object to compare with this delayed task.
+     * @param  other  the other delayed object to compare with this delayed task.
      * @return -1 if the other task should happen before this one, +1 if it should happen
after, or 0.
      */
     @Override
@@ -111,8 +111,8 @@ public abstract class DelayedRunnable im
         /**
          * Returns the delay, which is fixed to 0 in every cases.
          *
-         * @param  unit The unit of the value to return (ignored).
-         * @return The delay, which is fixed to 0.
+         * @param  unit  the unit of the value to return (ignored).
+         * @return the delay, which is fixed to 0.
          */
         @Override
         public final long getDelay(final TimeUnit unit) {

Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Threads.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Threads.java?rev=1770499&r1=1770498&r2=1770499&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Threads.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/internal/system/Threads.java
[UTF-8] Sat Nov 19 15:38:50 2016
@@ -21,9 +21,9 @@ import org.apache.sis.util.logging.Loggi
 
 
 /**
- * Utilities methods for threads. This class declares in a single place every {@link ThreadGroup}
- * used in SIS. Their intend is to bring some order in debugger informations, by grouping
the
- * threads created by SIS together under the same parent tree node.
+ * Utilities methods for threads. This class declares in a single place every {@link ThreadGroup}
used in SIS.
+ * Their intend is to bring some order in debugger informations, by grouping the threads
created by SIS together
+ * under the same parent tree node.
  *
  * <div class="section">Note on dependencies</div>
  * This class shall not depend on {@link ReferenceQueueConsumer} or {@link DelayedExecutor},
@@ -93,9 +93,9 @@ final class Threads extends Static {
      * <p><strong>This method is for internal use by Apache SIS shutdown hooks
only.</strong>
      * Users should never invoke this method explicitely.</p>
      *
-     * @param  stopWaitingAt A {@link System#nanoTime()} value telling when to stop waiting.
+     * @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 Thread#interrupt()}
while
+     * @throws InterruptedException if an other thread invoked {@link Thread#interrupt()}
while
      *         we were waiting for the daemon threads to die.
      */
     static synchronized void shutdown(final long stopWaitingAt) throws InterruptedException
{

Modified: sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/xml/MarshallerPool.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/xml/MarshallerPool.java?rev=1770499&r1=1770498&r2=1770499&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/xml/MarshallerPool.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-utility/src/main/java/org/apache/sis/xml/MarshallerPool.java
[UTF-8] Sat Nov 19 15:38:50 2016
@@ -160,8 +160,8 @@ public class MarshallerPool {
      * for the {@code Unmarshaller}, then consider overriding the {@link #createMarshaller()}
      * or {@link #createUnmarshaller()} methods instead.</p>
      *
-     * @param  properties The properties to be given to the (un)marshaller, or {@code null}
if none.
-     * @throws JAXBException If the JAXB context can not be created.
+     * @param  properties  the properties to be given to the (un)marshaller, or {@code null}
if none.
+     * @throws JAXBException if the JAXB context can not be created.
      */
     public MarshallerPool(final Map<String,?> properties) throws JAXBException {
         this(TypeRegistration.getSharedContext(), properties);
@@ -177,11 +177,11 @@ public class MarshallerPool {
      * for the {@code Unmarshaller}, then consider overriding the {@link #createMarshaller()}
      * or {@link #createUnmarshaller()} methods instead.</p>
      *
-     * @param  context The JAXB context.
-     * @param  properties The properties to be given to the (un)marshaller, or {@code null}
if none.
-     * @throws JAXBException If the marshaller pool can not be created.
+     * @param  context     the JAXB context.
+     * @param  properties  the properties to be given to the (un)marshaller, or {@code null}
if none.
+     * @throws JAXBException if the marshaller pool can not be created.
      */
-    @SuppressWarnings({"unchecked", "rawtypes"}) // Generic array creation
+    @SuppressWarnings({"unchecked", "rawtypes"})          // Generic array creation
     public MarshallerPool(final JAXBContext context, final Map<String,?> properties)
throws JAXBException {
         ArgumentChecks.ensureNonNull("context", context);
         this.context = context;
@@ -276,7 +276,7 @@ public class MarshallerPool {
     final void removeExpired() {
         isRemovalScheduled.set(false);
         final long now = System.nanoTime();
-        if (!removeExpired(marshallers, now) | // Really |, not ||
+        if (!removeExpired(marshallers, now) |                      // Really |, not ||
             !removeExpired(unmarshallers, now))
         {
             scheduleRemoval();
@@ -286,9 +286,9 @@ public class MarshallerPool {
     /**
      * Removes expired (un)marshallers from the given queue.
      *
-     * @param  <T>   Either {@code Marshaller} or {@code Unmarshaller} type.
-     * @param  queue The queue from which to remove expired (un)marshallers.
-     * @param  now   Current value of {@link System#nanoTime()}.
+     * @param  <T>    either {@code Marshaller} or {@code Unmarshaller} type.
+     * @param  queue  the queue from which to remove expired (un)marshallers.
+     * @param  now    current value of {@link System#nanoTime()}.
      * @return {@code true} if the queue became empty as a result of this method call.
      */
     private static <T> boolean removeExpired(final Deque<T> queue, final long
now) {
@@ -333,8 +333,8 @@ public class MarshallerPool {
      * Note that {@link #recycle(Marshaller)} shall not be invoked in case of exception,
      * since the marshaller may be in an invalid state.
      *
-     * @return A marshaller configured for formatting OGC/ISO XML.
-     * @throws JAXBException If an error occurred while creating and configuring a marshaller.
+     * @return a marshaller configured for formatting OGC/ISO XML.
+     * @throws JAXBException if an error occurred while creating and configuring a marshaller.
      */
     public Marshaller acquireMarshaller() throws JAXBException {
         Marshaller marshaller = marshallers.poll();
@@ -359,8 +359,8 @@ public class MarshallerPool {
      * Note that {@link #recycle(Unmarshaller)} shall not be invoked in case of exception,
      * since the unmarshaller may be in an invalid state.
      *
-     * @return A unmarshaller configured for parsing OGC/ISO XML.
-     * @throws JAXBException If an error occurred while creating and configuring the unmarshaller.
+     * @return a unmarshaller configured for parsing OGC/ISO XML.
+     * @throws JAXBException if an error occurred while creating and configuring the unmarshaller.
      */
     public Unmarshaller acquireUnmarshaller() throws JAXBException {
         Unmarshaller unmarshaller = unmarshallers.poll();
@@ -388,7 +388,7 @@ public class MarshallerPool {
      * Note that this method does not close any output stream.
      * Closing the marshaller stream is caller's or JAXB responsibility.
      *
-     * @param marshaller The marshaller to return to the pool.
+     * @param  marshaller  the marshaller to return to the pool.
      */
     public void recycle(final Marshaller marshaller) {
         recycle(marshallers, marshaller);
@@ -412,7 +412,7 @@ public class MarshallerPool {
      * Note that this method does not close any input stream.
      * Closing the unmarshaller stream is caller's or JAXB responsibility.
      *
-     * @param unmarshaller The unmarshaller to return to the pool.
+     * @param  unmarshaller  the unmarshaller to return to the pool.
      */
     public void recycle(final Unmarshaller unmarshaller) {
         recycle(unmarshallers, unmarshaller);
@@ -423,8 +423,8 @@ public class MarshallerPool {
      * This method is invoked only when no existing marshaller is available in the pool.
      * Subclasses can override this method if they need to change the marshaller configuration.
      *
-     * @return A new marshaller configured for formatting OGC/ISO XML.
-     * @throws JAXBException If an error occurred while creating and configuring the marshaller.
+     * @return a new marshaller configured for formatting OGC/ISO XML.
+     * @throws JAXBException if an error occurred while creating and configuring the marshaller.
      */
     protected Marshaller createMarshaller() throws JAXBException {
         final Marshaller marshaller = context.createMarshaller();
@@ -456,8 +456,8 @@ public class MarshallerPool {
      * This method is invoked only when no existing unmarshaller is available in the pool.
      * Subclasses can override this method if they need to change the unmarshaller configuration.
      *
-     * @return A new unmarshaller configured for parsing OGC/ISO XML.
-     * @throws JAXBException If an error occurred while creating and configuring the unmarshaller.
+     * @return a new unmarshaller configured for parsing OGC/ISO XML.
+     * @throws JAXBException if an error occurred while creating and configuring the unmarshaller.
      */
     protected Unmarshaller createUnmarshaller() throws JAXBException {
         final Unmarshaller unmarshaller = context.createUnmarshaller();



Mime
View raw message