1 /**
2 * This file Copyright (c) 2019 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.ui.dialog;
35
36 import info.magnolia.objectfactory.ComponentProvider;
37 import info.magnolia.ui.api.action.AbstractActionExecutor;
38 import info.magnolia.ui.api.action.ActionDefinition;
39 import info.magnolia.ui.api.action.ActionExecutionException;
40
41 import java.util.Collection;
42 import java.util.stream.Stream;
43
44 import lombok.Builder;
45
46 /**
47 * Action execution abstraction. Exist to ease the programming of attaching action executions to several
48 * triggers at the same time (e.g. button controls and the shortcuts). Keeps the reference to the bound
49 * action definition.
50 *
51 * The action can be triggered w/out any extra effort by calling {@link #execute()} method.
52 */
53 public class ActionExecution<T> {
54
55 /**
56 * Convenience method that allows to transform a collection of action definitions
57 * into a stream of executions.
58 */
59 public static <T> Stream<ActionExecution<T>> fromDefinitions(Collection<ActionDefinition> actionDefinitions, ComponentProvider componentProvider) {
60 return actionDefinitions.stream().map(actionDefinition -> (ActionExecution<T>) componentProvider.newInstance(ActionExecution.class, actionDefinition));
61 }
62
63 private final ActionDefinition actionDefinition;
64 private final SingleDefinitionActionExecutor actionExecutor;
65
66 public ActionExecution(ActionDefinition actionDefinition, ComponentProvider componentProvider) {
67 this.actionDefinition = actionDefinition;
68 this.actionExecutor = new SingleDefinitionActionExecutor(componentProvider, actionDefinition);
69 }
70
71 public void execute() {
72 try {
73 actionExecutor.execute(actionDefinition.getName());
74 } catch (ActionExecutionException ex) {
75 throw new RuntimeException(ex);
76 }
77 }
78
79 public ActionDefinition getDefinition() {
80 return this.actionDefinition;
81 }
82
83 private static class SingleDefinitionActionExecutor extends AbstractActionExecutor {
84
85 private final ActionDefinition definition;
86
87 @Builder
88 private SingleDefinitionActionExecutor(ComponentProvider componentProvider, ActionDefinition definition) {
89 super(componentProvider);
90 this.definition = definition;
91 }
92
93 @Override
94 public ActionDefinition getActionDefinition(String actionName) {
95 return definition;
96 }
97 }
98 }