View Javadoc
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  /**
39   * A task that delegates to another if a condition is true, or to an optional other if it is false.
40   *
41   * TODO : get descriptions from delegate + a description of the condition ?
42   */
43  public abstract class ConditionalDelegateTask extends AbstractTask {
44      private final Task ifTrue;
45      private final Task ifFalse;
46  
47      protected ConditionalDelegateTask(String taskName, String taskDescription, Task ifTrue) {
48          this(taskName, taskDescription, ifTrue, null);
49      }
50  
51      public ConditionalDelegateTask(String taskName, String taskDescription, Taskef="../../../../info/magnolia/module/delta/Task.html#Task">Task ifTrue, Task ifFalse) {
52          super(taskName, taskDescription);
53          this.ifTrue = ifTrue;
54          this.ifFalse = ifFalse;
55      }
56  
57      @Override
58      public void execute(InstallContext ctx) throws TaskExecutionException {
59          final Task task = condition(ctx) ? ifTrue : ifFalse;
60          if (task != null) {
61              task.execute(ctx);
62          }
63      }
64  
65      protected abstract boolean condition(InstallContext installContext) throws TaskExecutionException;
66  
67  }