View Javadoc

1   /**
2    * This file Copyright (c) 2003-2011 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.module.delta;
35  
36  import info.magnolia.module.InstallContext;
37  import org.apache.commons.lang.ArrayUtils;
38  
39  import java.util.Arrays;
40  
41  /**
42   * A task that simply delegates to an array of other tasks.
43   *
44   * @version $Revision: $ ($Author: $)
45   */
46  public class ArrayDelegateTask implements Task {
47      private String name;
48      private String description;
49      private Task[] tasks;
50  
51      public ArrayDelegateTask(String name) {
52          this(name, (String) null);
53      }
54  
55      public ArrayDelegateTask(String name, String description) {
56          this(name, description, new Task[0]);
57      }
58  
59      public ArrayDelegateTask(String name, Task... tasks) {
60          this(name, null, tasks);
61      }
62  
63      public ArrayDelegateTask(String name, String description, Task... tasks) {
64          this.name = name;
65          this.description = description;
66          this.tasks = tasks;
67      }
68  
69      @Override
70      public String getName() {
71          return name;
72      }
73  
74      /**
75       * Tasks are meant to be immutable. Avoid this if possible.
76       */
77      public void addTask(Task task) {
78          this.tasks = (Task[]) ArrayUtils.add(tasks, task);
79      }
80  
81      @Override
82      public String getDescription() {
83          if (description != null) {
84              return description;
85          }
86          final StringBuffer buf = new StringBuffer();
87          for (int i = 0; i < tasks.length; i++) {
88              if (i > 0) {
89                  buf.append(" "); // TODO : line break ?
90              }
91              buf.append(tasks[i].getDescription());
92          }
93          return buf.toString();
94      }
95  
96      @Override
97      public void execute(InstallContext ctx) throws TaskExecutionException {
98          for (Task task : tasks) {
99              task.execute(ctx);
100         }
101     }
102 
103     @Override
104     public String toString() {
105         return Arrays.toString(tasks);
106     }
107 }