View Javadoc
1   /**
2    * This file Copyright (c) 2003-2015 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.lang3.ArrayUtils;
38  
39  import java.util.Arrays;
40  
41  /**
42   * A task that simply delegates to an array of other tasks.
43   */
44  public class ArrayDelegateTask implements Task {
45      private String name;
46      private String description;
47      private Task[] tasks;
48  
49      public ArrayDelegateTask(String name) {
50          this(name, (String) null);
51      }
52  
53      public ArrayDelegateTask(String name, String description) {
54          this(name, description, new Task[0]);
55      }
56  
57      public ArrayDelegateTask(String name, Task... tasks) {
58          this(name, null, tasks);
59      }
60  
61      public ArrayDelegateTask(String name, String description, Task... tasks) {
62          this.name = name;
63          this.description = description;
64          this.tasks = tasks;
65      }
66  
67      @Override
68      public String getName() {
69          return name;
70      }
71  
72      /**
73       * Tasks are meant to be immutable. Avoid this if possible.
74       */
75      public void addTask(Task task) {
76          this.tasks = (Task[]) ArrayUtils.add(tasks, task);
77      }
78  
79      @Override
80      public String getDescription() {
81          if (description != null) {
82              return description;
83          }
84          final StringBuffer buf = new StringBuffer();
85          for (int i = 0; i < tasks.length; i++) {
86              if (i > 0) {
87                  buf.append(" "); // TODO : line break ?
88              }
89              buf.append(tasks[i].getDescription());
90          }
91          return buf.toString();
92      }
93  
94      @Override
95      public void execute(InstallContext ctx) throws TaskExecutionException {
96          for (Task task : tasks) {
97              task.execute(ctx);
98          }
99      }
100 
101     @Override
102     public String toString() {
103         return Arrays.toString(tasks);
104     }
105 }