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