1 /** 2 * This file Copyright (c) 2003-2016 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 import java.util.Collection; 41 import java.util.Map; 42 43 /** 44 * Contract for transformation from content to java beans. 45 * 46 * @deprecated since 5.2.4 - use {@link info.magnolia.jcr.node2bean.Node2BeanTransformer} instead. 47 */ 48 public interface Content2BeanTransformer { 49 50 /** 51 * Create a state object to share the state between the processor and transformer. 52 */ 53 public TransformationState newState(); 54 55 /** 56 * @deprecated since 4.5, use {@link #resolveType(TypeMapping, TransformationState, ComponentProvider)} 57 */ 58 public TypeDescriptor resolveType(TransformationState state) throws ClassNotFoundException; 59 60 /** 61 * Resolves the class to use for the current node. 62 */ 63 public TypeDescriptor resolveType(TypeMapping typeMapping, TransformationState state, ComponentProvider componentProvider) throws ClassNotFoundException; 64 65 /** 66 * Returns the children of the node to be transformed. Those are normally the direct children but might differ. 67 */ 68 public Collection<Content> getChildren(Content node); 69 70 /** 71 * Instantiates the bean. 72 */ 73 public Object newBeanInstance(TransformationState state, Map values, ComponentProvider componentProvider) throws Content2BeanException; 74 75 /** 76 * Called after all properties are set. 77 */ 78 public void initBean(TransformationState state, Map values) throws Content2BeanException; 79 80 /** 81 * @deprecated since 4.5, use {@link #setProperty(TypeMapping, TransformationState, PropertyTypeDescriptor, java.util.Map)} 82 */ 83 public void setProperty(TransformationState state, PropertyTypeDescriptor descriptor, Map<String, Object> values); 84 85 /** 86 * Set this property on that bean. Allows excluding of properties. 87 */ 88 public void setProperty(TypeMapping typeMapping, TransformationState state, PropertyTypeDescriptor descriptor, Map<String, Object> values); 89 90 /** 91 * Transforms the simple basic jcr property value objects to more complex properties. 92 */ 93 public Object convertPropertyValue(Class<?> propertyType, Object value) throws Content2BeanException; 94 95 /** 96 * The mapping to use. 97 * 98 * @deprecated since 4.5, do not use 99 */ 100 public TypeMapping getTypeMapping(); 101 102 /** 103 * Creates singleton instance of content2bean transformer. 104 * 105 * @deprecated since 4.5, we should use IoC... 106 */ 107 class Factory { 108 public static Content2BeanTransformer getDefaultTransformer() { 109 return Components.getSingleton(Content2BeanTransformer.class); 110 } 111 } 112 }