1 /**
2 * This file Copyright (c) 2016-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.ui.framework;
35
36 import java.util.List;
37 import java.util.stream.Stream;
38
39 /**
40 * Interface for components which manage copy/paste operations over the objects of some specific domain.
41 *
42 * @param <T>
43 * clipboard item type
44 */
45 public interface ContentClipboard<T> {
46
47 /**
48 * Save the information about provided objects to be saved to the clipboard.
49 */
50 default void cut(final List<T> source) {
51 throw new UnsupportedOperationException();
52 }
53
54 /**
55 * Verifies whether there is nothing stored in the clipboard
56 * at the moment.
57 */
58 default boolean isEmpty() {
59 return getContents().count() == 0;
60 }
61
62 /**
63 * Allows to inspect the current contents of the clipboard
64 */
65 default Stream<T> getContents() {
66 throw new UnsupportedOperationException();
67 }
68
69 /**
70 * Save the information about provided objects to be saved to the clipboard.
71 */
72 void copy(List<T> source);
73
74 /**
75 * Paste objects into the clipboard under the provided object.
76 * @return List<T> list of objects that were successfully pasted.
77 */
78 List<T> paste(T destination);
79
80 default List<T> pasteToRoot() {
81 return paste(null);
82 }
83
84 /**
85 * Check whether given objects can be copied into the clipboard.
86 */
87 boolean canCopy(List<T> source);
88
89 /**
90 * Check whether objects in the clipboard can be pasted under given object.
91 */
92 boolean canPasteInto(T destination);
93
94 default boolean canPasteInto() {
95 return canPasteInto(null);
96 }
97 }