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.content2bean;
35
36 import info.magnolia.cms.core.ItemType;
37
38
39 /**
40 * Used to create content nodes. This is a kind of configuration for the processor.
41 *
42 * @deprecated since 5.2.4 - unused, Bean2Content is not implemented yet.
43 */
44 public interface Bean2ContentTransformer {
45
46 /**
47 * The item type of the node.
48 */
49 public ItemType resolveItemType(TransformationState state);
50
51 /**
52 * The content name to use.
53 */
54 public ItemType resolveName(TransformationState state);
55
56 /**
57 * Set mixin types or similar. Does not create the node!
58 */
59 public ItemType prepareContent(TransformationState state);
60
61 /**
62 * Called after the node data and child content is set.
63 */
64 public ItemType finishContent(TransformationState state);
65
66 /**
67 * Will this property be a node?
68 */
69 public boolean isNode(TransformationState state, String propertyName, Object value);
70
71 /**
72 * Will this property be a node data?
73 */
74 public boolean isProperty(TransformationState state, String propertyName, Object value);
75
76 /**
77 * Create/set the node data of the node.
78 */
79 public void setNodeData(TransformationState state, String name, Object value);
80
81 /**
82 * Convert complex values to the basic supported types (int, boolean, .. String)
83 */
84 public Object convertNodeDataValue(TransformationState state, String name, Object value);
85 }