You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lenya.apache.org by an...@apache.org on 2003/08/18 14:33:26 UTC
cvs commit: cocoon-lenya/src/java/org/apache/lenya/cms/scheduler/xml TriggerHelper.java
andreas 2003/08/18 05:33:26
Modified: src/java/org/apache/lenya/cms/scheduler/xml
TriggerHelper.java
Log:
cleaned up code and javadocs
Revision Changes Path
1.15 +29 -21 cocoon-lenya/src/java/org/apache/lenya/cms/scheduler/xml/TriggerHelper.java
Index: TriggerHelper.java
===================================================================
RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/cms/scheduler/xml/TriggerHelper.java,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- TriggerHelper.java 23 Jul 2003 13:21:34 -0000 1.14
+++ TriggerHelper.java 18 Aug 2003 12:33:26 -0000 1.15
@@ -74,11 +74,16 @@
/**
- * DOCUMENT ME!
+ * Utility class to work with trigger XML.
*
- * @author ah
+ * @author Andreas Hartmann
+ * @author Michael Wechner
*/
public final class TriggerHelper {
+
+ /**
+ * Ctor.
+ */
private TriggerHelper() {
}
@@ -95,13 +100,13 @@
private static int id = 0;
/**
- * DOCUMENT ME!
+ * Creates a trigger from an XML element.
*
- * @param element DOCUMENT ME!
- * @param jobName DOCUMENT ME!
- * @param jobGroup DOCUMENT ME!
+ * @param element The XML element.
+ * @param jobName The job name.
+ * @param jobGroup The job group.
*
- * @return DOCUMENT ME!
+ * @return A trigger.
*/
public static Trigger createTrigger(Element element, String jobName, String jobGroup) {
if (!element.getLocalName().equals("trigger")) {
@@ -168,16 +173,20 @@
throw new IllegalStateException("Trigger type '" + triggerType + "' not defined!");
}
+ /**
+ * Creates a unique trigger ID.
+ * @return A string.
+ */
protected static String createUniqueTriggerId() {
return "trigger_" + id++;
}
/**
- * DOCUMENT ME!
+ * Creates a simple trigger.
*
- * @param jobName DOCUMENT ME!
- * @param jobGroup DOCUMENT ME!
- * @param date DOCUMENT ME!
+ * @param jobName The job name.
+ * @param jobGroup The job group.
+ * @param date The trigger date.
*
* @return DOCUMENT ME!
*/
@@ -187,14 +196,14 @@
}
/**
- * author Michael Wechner Create CronTrigger
+ * Creates a cron trigger.
*
- * @param jobName DOCUMENT ME!
- * @param jobGroup DOCUMENT ME!
+ * @param jobName The job name.
+ * @param jobGroup The job group.
* @param cron_expression Seconds, Minutes, Hours, Day of Month, Months, Day of Week (e.g. 34
* ?)
*
- * @return DOCUMENT ME!
+ * @return A trigger.
*/
public static Trigger createCronTrigger(String jobName, String jobGroup, String cron_expression) {
try {
@@ -208,11 +217,10 @@
}
/**
- * DOCUMENT ME!
- *
- * @param trigger DOCUMENT ME!
- *
- * @return DOCUMENT ME!
+ * Creates an XML element containing trigger information.
+ * @param helper The namespace helper to use.
+ * @param trigger The trigger.
+ * @return An XML element.
*/
public static Element createElement(NamespaceHelper helper, Trigger trigger) {
Element triggerElement = helper.createElement("trigger");
---------------------------------------------------------------------
To unsubscribe, e-mail: lenya-cvs-unsubscribe@cocoon.apache.org
For additional commands, e-mail: lenya-cvs-help@cocoon.apache.org