1 /**
2 * This file Copyright (c) 2017 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.transformer;
35
36 import info.magnolia.jcr.node2bean.TypeDescriptor;
37 import info.magnolia.objectfactory.annotation.Multibinding;
38
39 import java.util.Map;
40 import java.util.Optional;
41
42 /**
43 * {@link TypeResolver} attempts to deduce the object type from the provided
44 * properties related to that object.
45 * <p>
46 * Historically to-bean transformers in Magnolia contained similar
47 * functionality which is now provided as the default implementation
48 * of this interface ({@link ClassPropertyBasedTypeResolver}).
49 * </p>
50 * <p>
51 * This interface is closely related to the {@link BeanTypeResolver}
52 * component which manages the instances of {@link TypeResolver type resolvers}.
53 * </p>
54 * <p><strong>NOTE:</strong> for the time being this class is meant for the internal use only
55 * and is a subject to change any moment!</p>
56 */
57 @Multibinding
58 public interface TypeResolver {
59
60 /**
61 * Attempt to resolve the object type based on its properties.
62 *
63 * @param properties raw map of related bean properties
64 *
65 * @return {@link Optional} instance containing the resolved class
66 * in case of successful resolution or {@link Optional#empty()} otherwise.
67 */
68 Optional<Class<?>> resolve(Map<String, Object> properties);
69
70 /**
71 * Report whether current resolver is capable of dealing with
72 * the object types related to the one provided.
73 *
74 * @param typeDescriptor type descriptor
75 * @return {@code true} if current resolver is capable of resolving the
76 * descendants of the type described by the provided type descriptor,
77 * {@code false} otherwise.
78 */
79 boolean supportsType(TypeDescriptor typeDescriptor);
80 }