1 /**
2 * This file Copyright (c) 2013-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.form.field.transformer;
35
36 import info.magnolia.ui.api.i18n.I18NAwareHandler;
37
38
39 /**
40 * Base definition for a {@link com.vaadin.v7.data.Property} handler.<br>
41 * Implemented Transformer have the responsibility to : <br>
42 * - write : Convert the T newValue to a specific Item format (Single Item property, Multi Item property, Multi sub Items...) <br>
43 * - read : Transform a specific Item values (single property, Multi. property, sub Items) to a specified type T. <br>
44 *
45 * @param <T> type of the element handled.
46 */
47 public interface Transformer<T> extends I18NAwareHandler {
48
49 /**
50 * Convert the T newValue to a specific Item format.<br>
51 */
52 void writeToItem(T newValue);
53
54 /**
55 * Transform a specific Item values to a specified type T.<br>
56 */
57 T readFromItem();
58
59 /**
60 * Return true if this Property has to support i18n.
61 */
62 boolean hasI18NSupport();
63
64 /**
65 * @return type
66 * the type of the value. <code>value</code> must be assignable
67 * to this type.
68 */
69 Class<T> getType();
70
71 /**
72 * Mirror the read-only state of the underlying Property / data-source.
73 */
74 boolean isReadOnly();
75
76 /**
77 * @deprecated since 5.4.12. Transformer just mirrors read-only state of the underlying Property,
78 * invoke <code>#setReadOnly</code> on the {@link TransformedProperty} instead
79 */
80 @Deprecated
81 void setReadOnly(boolean isReadOnly);
82
83 }