cocoon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From andr...@apache.org
Subject cvs commit: cocoon-2.1/src/blocks/workflow/java/org/apache/lenya/workflow/impl TransitionImpl.java WorkflowBuilder.java WorkflowImpl.java
Date Mon, 01 Mar 2004 11:10:00 GMT
andreas     2004/03/01 03:10:00

  Modified:    src/blocks/workflow/java/org/apache/lenya/workflow/impl
                        TransitionImpl.java WorkflowBuilder.java
                        WorkflowImpl.java
  Log:
  added more javadocs
  
  Revision  Changes    Path
  1.3       +17 -25    cocoon-2.1/src/blocks/workflow/java/org/apache/lenya/workflow/impl/TransitionImpl.java
  
  Index: TransitionImpl.java
  ===================================================================
  RCS file: /home/cvs/cocoon-2.1/src/blocks/workflow/java/org/apache/lenya/workflow/impl/TransitionImpl.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- TransitionImpl.java	1 Mar 2004 10:36:22 -0000	1.2
  +++ TransitionImpl.java	1 Mar 2004 11:10:00 -0000	1.3
  @@ -90,18 +90,16 @@
       private boolean isSynchronized = false;
   
       /**
  -     * DOCUMENT ME!
  -     *
  -     * @return DOCUMENT ME!
  +     * Returns the actions which are assigned tothis transition.
  +     * @return An array of actions.
        */
       public Action[] getActions() {
           return (Action[]) actions.toArray(new Action[actions.size()]);
       }
   
       /**
  -     * DOCUMENT ME!
  -     *
  -     * @param action DOCUMENT ME!
  +     * Assigns an action to this transition.
  +     * @param action The action.
        */
       public void addAction(Action action) {
           actions.add(action);
  @@ -110,18 +108,16 @@
       private List conditions = new ArrayList();
   
       /**
  -     * DOCUMENT ME!
  -     *
  -     * @return DOCUMENT ME!
  +     * Returns the conditions which are assigned to this transition.
  +     * @return An array of conditions.
        */
       public Condition[] getConditions() {
           return (Condition[]) conditions.toArray(new Condition[conditions.size()]);
       }
   
       /**
  -     * DOCUMENT ME!
  -     *
  -     * @param condition DOCUMENT ME!
  +     * Assigns a condition to this transition.
  +     * @param condition The condition.
        */
       public void addCondition(Condition condition) {
           conditions.add(condition);
  @@ -130,18 +126,16 @@
       private Event event;
   
       /**
  -     * DOCUMENT ME!
  -     *
  -     * @return DOCUMENT ME!
  +     * Returns the event which invokes this transition.
  +     * @return An event.
        */
       public Event getEvent() {
           return event;
       }
   
       /**
  -     * DOCUMENT ME!
  -     *
  -     * @param anEvent DOCUMENT ME!
  +     * Sets the event to invoke this transition.
  +     * @param anEvent An event.
        */
       public void setEvent(Event anEvent) {
           event = anEvent;
  @@ -150,9 +144,8 @@
       private StateImpl source;
   
       /**
  -     * DOCUMENT ME!
  -     *
  -     * @return DOCUMENT ME!
  +     * Returns the source state of this transition.
  +     * @return A state.
        */
       public StateImpl getSource() {
           return source;
  @@ -161,9 +154,8 @@
       private StateImpl destination;
   
       /**
  -     * DOCUMENT ME!
  -     *
  -     * @return DOCUMENT ME!
  +     * Returns the destination state of this transition.
  +     * @return A state.
        */
       public StateImpl getDestination() {
           return destination;
  
  
  
  1.3       +5 -8      cocoon-2.1/src/blocks/workflow/java/org/apache/lenya/workflow/impl/WorkflowBuilder.java
  
  Index: WorkflowBuilder.java
  ===================================================================
  RCS file: /home/cvs/cocoon-2.1/src/blocks/workflow/java/org/apache/lenya/workflow/impl/WorkflowBuilder.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- WorkflowBuilder.java	1 Mar 2004 10:36:22 -0000	1.2
  +++ WorkflowBuilder.java	1 Mar 2004 11:10:00 -0000	1.3
  @@ -89,13 +89,10 @@
       }
   
       /**
  -     * DOCUMENT ME!
  -     *
  -     * @param file DOCUMENT ME!
  -     *
  -     * @return DOCUMENT ME!
  -     *
  -     * @throws WorkflowException DOCUMENT ME!
  +     * Builds a workflow schema from a file.
  +     * @param file The file.
  +     * @return A workflow schema implementation.
  +     * @throws WorkflowException if the file does not represent a valid workflow schema.
        */
       public static WorkflowImpl buildWorkflow(File file) throws WorkflowException {
           WorkflowImpl workflow;
  
  
  
  1.3       +9 -15     cocoon-2.1/src/blocks/workflow/java/org/apache/lenya/workflow/impl/WorkflowImpl.java
  
  Index: WorkflowImpl.java
  ===================================================================
  RCS file: /home/cvs/cocoon-2.1/src/blocks/workflow/java/org/apache/lenya/workflow/impl/WorkflowImpl.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- WorkflowImpl.java	1 Mar 2004 10:36:22 -0000	1.2
  +++ WorkflowImpl.java	1 Mar 2004 11:10:00 -0000	1.3
  @@ -189,13 +189,10 @@
       }
   
       /**
  -     * DOCUMENT ME!
  -     *
  -     * @param name DOCUMENT ME!
  -     *
  -     * @return DOCUMENT ME!
  -     *
  -     * @throws WorkflowException DOCUMENT ME!
  +     * Returns the event for a certain event name.
  +     * @param name A string.
  +     * @return The event with this name.
  +     * @throws WorkflowException when no event with the given name exists.
        */
       public EventImpl getEvent(String name) throws WorkflowException {
           if (!events.containsKey(name)) {
  @@ -216,13 +213,10 @@
       }
   
       /**
  -     * DOCUMENT ME!
  -     *
  -     * @param name DOCUMENT ME!
  -     *
  -     * @return DOCUMENT ME!
  -     *
  -     * @throws WorkflowException DOCUMENT ME!
  +     * Returns the variable for a certain name.
  +     * @param name The name of the variable.
  +     * @return A variable.
  +     * @throws WorkflowException if no variable with the given name exists.
        */
       public BooleanVariableImpl getVariable(String name)
           throws WorkflowException {
  
  
  

Mime
View raw message