1 /**
2 * This file Copyright (c) 2012-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.jcr.node2bean;
35
36 import info.magnolia.objectfactory.ComponentProvider;
37 import info.magnolia.transformer.ToBeanTransformer;
38 import info.magnolia.transformer.TransformationResult;
39
40 import javax.jcr.Node;
41 import javax.jcr.RepositoryException;
42
43 /**
44 * Transforms nodes to beans or maps. The transformer is use to resolve classes or to instantiate beans.
45 */
46 public interface Node2BeanProcessor extends ToBeanTransformer<Node> {
47
48 /**
49 * Helper method which complements {@link ToBeanTransformer} interface allowing Node2Bean processing to be accomplished
50 * with a custom {@link Node2BeanTransformer transformer instance}.
51 */
52 <T> TransformationResult<T> transform(Node node, Class<T> type, Node2BeanTransformer transformer);
53
54 /**
55 * Transforms given node to bean.
56 *
57 * @param node which will be transformed to bean
58 * @return bean object
59 */
60 Object toBean(Node node) throws Node2BeanException, RepositoryException;
61
62 /**
63 * Transforms given node to bean. Class parameter will be used in transformer as default type.
64 *
65 * @param node which will be transformed to bean
66 * @param defaultClass default type
67 * @return bean object
68 */
69 Object toBean(Node node, Class<?> defaultClass) throws Node2BeanException, RepositoryException;
70
71 /**
72 * Transforms the node to a bean using the passed transformer and component provider.
73 *
74 * @param node which will be transformed to bean
75 * @param recursive if set to true then all subnodes will be transformed as well
76 * @return bean object
77 */
78 Object toBean(Node node, boolean recursive, final Node2BeanTransformer transformer, ComponentProvider componentProvider) throws Node2BeanException, RepositoryException;
79
80 /**
81 * Similar to <code>toBean()</code> but uses a passed bean as the root bean.
82 *
83 * @todo better name - configureBean
84 */
85 Object setProperties(final Object bean, Node node, boolean recursive, final Node2BeanTransformer transformer, ComponentProvider componentProvider) throws Node2BeanException, RepositoryException;
86
87 }