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