View Javadoc
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.Content;
37  import info.magnolia.objectfactory.ComponentProvider;
38  import info.magnolia.objectfactory.Components;
39  
40  
41  /**
42   * Transforms nodes to beans or maps. The transformer is use to resolve classes or to instantiate beans.
43   *
44   * @deprecated since 4.5, use {@link Content2Bean}.
45   */
46  public interface Content2BeanProcessor {
47  
48      /**
49       * Transforms the node to a bean using the passed transformer and component provider.
50       */
51      public Object toBean(Content node, boolean recursive, final Content2BeanTransformer transformer, ComponentProvider componentProvider)
52              throws Content2BeanException;
53  
54      /**
55       * Similar to <code>toBean()</code> but uses a passed bean as the root bean.
56       */
57      public Object setProperties(final Object bean, Content node, boolean recursive, final Content2BeanTransformer transformer, ComponentProvider componentProvider) throws Content2BeanException;
58  
59      /**
60       * Creates a singleton instance of the content2bean processor.
61       *
62       * @deprecated since 4.5, we should use IoC. However, we'll leave the processor as is for now.
63       */
64      class Factory {
65          public static Content2BeanProcessor getProcessor() {
66              return Components.getSingleton(Content2BeanProcessor.class);
67          }
68      }
69  
70  }