commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ma...@apache.org
Subject svn commit: r1816119 - in /commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon: Daemon.java DaemonContext.java DaemonController.java DaemonPermission.java support/DaemonConfiguration.java
Date Thu, 23 Nov 2017 10:23:35 GMT
Author: markt
Date: Thu Nov 23 10:23:35 2017
New Revision: 1816119

URL: http://svn.apache.org/viewvc?rev=1816119&view=rev
Log:
Fix Javadoc warnings when building with Java 8

Modified:
    commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/Daemon.java
    commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonContext.java
    commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonController.java
    commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonPermission.java
    commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/support/DaemonConfiguration.java

Modified: commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/Daemon.java
URL: http://svn.apache.org/viewvc/commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/Daemon.java?rev=1816119&r1=1816118&r2=1816119&view=diff
==============================================================================
--- commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/Daemon.java (original)
+++ commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/Daemon.java Thu Nov
23 10:23:35 2017
@@ -61,7 +61,7 @@ public interface Daemon
      *
      * @param context A <code>DaemonContext</code> object used to
      * communicate with the container.
-     * @throws DaemonInitException An exception that prevented 
+     * @throws DaemonInitException An exception that prevented
      * initialization where you want to display a nice message to the user,
      * rather than a stack trace.
      * @throws Exception Any exception preventing a successful
@@ -78,6 +78,8 @@ public interface Daemon
      * method are free to start any number of threads, but need to
      * return control after having done that to enable invocation of
      * the stop()-method.
+     *
+     * @throws Exception If the start was not successful
      */
     public void start()
         throws Exception;
@@ -88,6 +90,8 @@ public interface Daemon
      * sockets or file descriptors is in the destroy method, as the
      * container may restart the Daemon by calling start() after
      * stop().
+     *
+     * @throws Exception If the stop was not successful
      */
     public void stop()
         throws Exception;

Modified: commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonContext.java
URL: http://svn.apache.org/viewvc/commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonContext.java?rev=1816119&r1=1816118&r2=1816119&view=diff
==============================================================================
--- commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonContext.java
(original)
+++ commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonContext.java
Thu Nov 23 10:23:35 2017
@@ -26,17 +26,17 @@ public interface DaemonContext
 {
 
     /**
-     * Returns  <code>DaemonController</code> object that can be used
-     * to control the <code>Daemon</code> instance that this
-     * <code>DaemonContext</code> is passed to.
+     * @return  A {@link DaemonController} object that can be used to control
+     *          the {@link Daemon} instance that this <code>DaemonContext</code>
+     *          is passed to.
      */
     public DaemonController getController();
 
     /**
-     * Returns an array of <code>String</code> arguments supplied by
-     * the environment.  corresponding to the array of arguments given
-     * in the <code>public static void main()</code> method used as an
-     * entry point to most other java programs.
+     * @return An array of {@link String} arguments supplied by the environment
+     *         corresponding to the array of arguments given in the
+     *         <code>public static void main()</code> method used as an entry
+     *         point to most other java programs.
      */
     public String[] getArguments();
 

Modified: commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonController.java
URL: http://svn.apache.org/viewvc/commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonController.java?rev=1816119&r1=1816118&r2=1816119&view=diff
==============================================================================
--- commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonController.java
(original)
+++ commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonController.java
Thu Nov 23 10:23:35 2017
@@ -25,37 +25,62 @@ public interface DaemonController
 {
 
     /**
-     * Shuts down the daemon.     
+     * Shuts down the daemon.
+     *
+     * @throws IllegalStateException If the daemon is not in a valid state to be
+     *                               shutdown
      */
     public void shutdown()
         throws IllegalStateException;
 
     /**
      * Reloads daemon
+     *
+     * @throws IllegalStateException If the daemon is not in a valid state to be
+     *                               reloaded
      */
     public void reload()
         throws IllegalStateException;
 
     /**
      * Shuts down daemon and logs failed message.
+     *
+     * @throws IllegalStateException If the daemon is not in a valid state to be
+     *                               shutdown
      */
     public void fail()
         throws IllegalStateException;
 
     /**
      * Shuts down daemon and logs failed message.
+     *
+     * @param   message The message to log
+     *
+     * @throws IllegalStateException If the daemon is not in a valid state to be
+     *                               shutdown
      */
     public void fail(String message)
         throws IllegalStateException;
 
     /**
      * Shuts down daemon and logs failed message.
+     *
+     * @param   exception   The exception to log
+     *
+     * @throws IllegalStateException If the daemon is not in a valid state to be
+     *                               shutdown
      */
     public void fail(Exception exception)
         throws IllegalStateException;
 
     /**
      * Shuts down daemon and logs failed message.
+     *
+     * @param   message     The message to log
+     * @param   exception   The exception to log
+     *
+     * @throws IllegalStateException If the daemon is not in a valid state to be
+     *                               shutdown
      */
     public void fail(String message, Exception exception)
         throws IllegalStateException;

Modified: commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonPermission.java
URL: http://svn.apache.org/viewvc/commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonPermission.java?rev=1816119&r1=1816118&r2=1816119&view=diff
==============================================================================
--- commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonPermission.java
(original)
+++ commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/DaemonPermission.java
Thu Nov 23 10:23:35 2017
@@ -35,8 +35,8 @@ import java.util.StringTokenizer;
  * special &quot;*&quot; value implies all permissions for the given
  * name:
  * </p>
- * <p>
  * <table width="100%" border="1">
+ *  <caption>Supported Actions</caption>
  *  <tr>
  *   <th>Target&quot;Name</th>
  *   <th>Action</th>
@@ -80,8 +80,6 @@ import java.util.StringTokenizer;
  *   </td>
  *  </tr>
  * </table>
- * </p>
- *
  */
 public final class DaemonPermission extends Permission
 {
@@ -208,8 +206,6 @@ public final class DaemonPermission exte
     /**
      * Creates a new <code>DaemonPermission</code> instance with a specified
      * permission name and a specified list of actions.
-     * <p>
-     * </p>
      *
      * @param target The target name of this permission.
      * @param actions The list of actions permitted by this permission.

Modified: commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/support/DaemonConfiguration.java
URL: http://svn.apache.org/viewvc/commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/support/DaemonConfiguration.java?rev=1816119&r1=1816118&r2=1816119&view=diff
==============================================================================
--- commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/support/DaemonConfiguration.java
(original)
+++ commons/proper/daemon/trunk/src/main/java/org/apache/commons/daemon/support/DaemonConfiguration.java
Thu Nov 23 10:23:35 2017
@@ -161,6 +161,8 @@ public final class DaemonConfiguration
      * @param name The name of the property to get.
      *
      * @throws ParseException if the property is wrongly formatted.
+     *
+     * @return  Configuration property including any expansion/replacement
      */
     public String getProperty(final String name)
         throws ParseException
@@ -185,6 +187,8 @@ public final class DaemonConfiguration
      * @param name The name of the property array to get.
      *
      * @throws ParseException if the property is wrongly formatted.
+     *
+     * @return  Configuration property array including any expansion/replacement
      */
     public String[] getPropertyArray(final String name)
         throws ParseException



Mime
View raw message