incubator-ace-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ma...@apache.org
Subject svn commit: r939480 - /incubator/ace/trunk/ace-scheduler-api/src/main/java/org/apache/ace/scheduler/constants/SchedulerConstants.java
Date Thu, 29 Apr 2010 20:48:15 GMT
Author: marrs
Date: Thu Apr 29 20:48:15 2010
New Revision: 939480

URL: http://svn.apache.org/viewvc?rev=939480&view=rev
Log:
Added documentation to the scheduler constants.

Modified:
    incubator/ace/trunk/ace-scheduler-api/src/main/java/org/apache/ace/scheduler/constants/SchedulerConstants.java

Modified: incubator/ace/trunk/ace-scheduler-api/src/main/java/org/apache/ace/scheduler/constants/SchedulerConstants.java
URL: http://svn.apache.org/viewvc/incubator/ace/trunk/ace-scheduler-api/src/main/java/org/apache/ace/scheduler/constants/SchedulerConstants.java?rev=939480&r1=939479&r2=939480&view=diff
==============================================================================
--- incubator/ace/trunk/ace-scheduler-api/src/main/java/org/apache/ace/scheduler/constants/SchedulerConstants.java
(original)
+++ incubator/ace/trunk/ace-scheduler-api/src/main/java/org/apache/ace/scheduler/constants/SchedulerConstants.java
Thu Apr 29 20:48:15 2010
@@ -18,11 +18,18 @@
  */
 package org.apache.ace.scheduler.constants;
 
-public interface SchedulerConstants
-{
+/**
+ * Compile time constants for the scheduler.
+ */
+public interface SchedulerConstants {
+    /** Persistent ID for the scheduler, provided for configuration purposes. */
     public static final String SCHEDULER_PID = "org.apache.ace.scheduler";
+    /** Name of the task that will be scheduled. */
     public static final String SCHEDULER_NAME_KEY = "taskName";
+    /** Description of the task. */
     public static final String SCHEDULER_DESCRIPTION_KEY = "description";
+    /** The recipe describing when the task should be scheduled. */
     public static final String SCHEDULER_RECIPE = "recipe";
+    /** Determines if the recipe provided in the task overrides any recipe that is configured.
*/
     public static final String SCHEDULER_RECIPE_OVERRIDE = "override";
 }
\ No newline at end of file



Mime
View raw message