1 /**
2 * This file Copyright (c) 2003-2010 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 * @author gjoseph
45 * @version $Revision: $ ($Author: $)
46 */
47 public class ArrayDelegateTask implements Task {
48 private String name;
49 private String description;
50 private Task[] tasks;
51
52 public ArrayDelegateTask(String name) {
53 this(name, (String) null);
54 }
55
56 public ArrayDelegateTask(String name, String description) {
57 this(name, description, new Task[0]);
58 }
59
60 public ArrayDelegateTask(String name, Task... tasks) {
61 this(name, null, tasks);
62 }
63
64 public ArrayDelegateTask(String name, String description, Task... tasks) {
65 this.name = name;
66 this.description = description;
67 this.tasks = tasks;
68 }
69
70 /**
71 * Since 4.2: replaced by the varargs constructor. Informally deprecated; will be removed in 4.3.
72 */
73 public ArrayDelegateTask(String name, Task task1, Task task2) {
74 this(name, (String) null, task1, task2);
75 }
76
77 /**
78 * Since 4.2: replaced by the varargs constructor. Informally deprecated; will be removed in 4.3.
79 */
80 public ArrayDelegateTask(String name, String description, Task task1, Task task2) {
81 this(name, description, new Task[]{task1, task2});
82 }
83
84 /**
85 * Since 4.2: replaced by the varargs constructor. Informally deprecated; will be removed in 4.3.
86 */
87 public ArrayDelegateTask(String name, Task task1, Task task2, Task task3) {
88 this(name, (String) null, task1, task2, task3);
89 }
90
91 /**
92 * Since 4.2: replaced by the varargs constructor. Informally deprecated; will be removed in 4.3.
93 */
94 public ArrayDelegateTask(String name, String description, Task task1, Task task2, Task task3) {
95 this(name, description, new Task[]{task1, task2, task3});
96 }
97
98 /**
99 * Since 4.2: replaced by the varargs constructor. Informally deprecated; will be removed in 4.3.
100 */
101 public ArrayDelegateTask(String name, Task task1, Task task2, Task task3, Task task4) {
102 this(name, null, task1, task2, task3, task4);
103 }
104
105 /**
106 * Since 4.2: replaced by the varargs constructor. Informally deprecated; will be removed in 4.3.
107 */
108 public ArrayDelegateTask(String name, String description, Task task1, Task task2, Task task3, Task task4) {
109 this(name, description, new Task[]{task1, task2, task3, task4});
110 }
111
112 public String getName() {
113 return name;
114 }
115
116 /**
117 * Tasks are meant to be immutable. Avoid this if possible.
118 */
119 public void addTask(Task task) {
120 this.tasks = (Task[]) ArrayUtils.add(tasks, task);
121 }
122
123 public String getDescription() {
124 if (description != null) {
125 return description;
126 } else {
127 final StringBuffer buf = new StringBuffer();
128 for (int i = 0; i < tasks.length; i++) {
129 if (i > 0) {
130 buf.append(" "); // TODO : line break ?
131 }
132 buf.append(tasks[i].getDescription());
133 }
134 return buf.toString();
135 }
136 }
137
138 public void execute(InstallContext ctx) throws TaskExecutionException {
139 for (Task task : tasks) {
140 task.execute(ctx);
141 }
142 }
143
144 public String toString() {
145 return Arrays.toString(tasks);
146 }
147 }