1 /**
2 * This file Copyright (c) 2017-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.transformer;
35
36 import info.magnolia.jcr.node2bean.TypeDescriptor;
37
38 import java.util.Collections;
39 import java.util.Map;
40 import java.util.Optional;
41 import java.util.Set;
42
43 import javax.inject.Inject;
44
45 /**
46 * BeanTypeResolver is a utility which allows the developers to inject custom bean
47 * type deduction logic into the to-bean transformers.
48 * <p>
49 * The main purpose of this class is to aggregate and orchestrate the instances
50 * of {@link TypeResolver} components, which in turn actually provide the resolution
51 * logic.
52 * </p>
53 * <p>
54 * At the moment {@link BeanTypeResolver} simply picks the first {@link TypeResolver type resolver}
55 * capable of handling the current data and delegates the type resolution to it.
56 * </p>
57 * <p><strong>NOTE:</strong> for the time being this class is meant for the internal use only and is a subject to change any moment!</p>
58 *
59 * @see ClassPropertyBasedTypeResolver
60 */
61 public final class BeanTypeResolver {
62
63 private final Set<TypeResolver> resolvers;
64
65 public BeanTypeResolver() {
66 this(Collections.singleton(new ClassPropertyBasedTypeResolver()));
67 }
68
69 @Inject
70 public BeanTypeResolver(Set<TypeResolver> resolvers) {
71 this.resolvers = resolvers;
72 }
73
74 /**
75 * Resolve the exact bean type from the provided base type information and the map of raw bean properties.
76 *
77 * @param typeDescriptor type descriptor corresponding to the base class or interfaces, the descendant of which needs
78 * to be resolved.
79 * @param properties raw map of bean properties (depending on the case and the transformer type may also contain
80 * additional metadata information)
81 *
82 * @return resolved bean type
83 */
84 public Optional<Class<?>> resolve(TypeDescriptor typeDescriptor, Map<String, Object> properties) {
85 return resolvers.stream()
86 .map(resolver -> resolver.resolveType(typeDescriptor, properties))
87 .filter(Optional::isPresent)
88 .findFirst()
89 .orElse(Optional.empty());
90 }
91 }