1 /**
2 * This file Copyright (c) 2012-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.jcr.node2bean;
35
36 import java.beans.PropertyDescriptor;
37 import java.util.Collections;
38 import java.util.HashMap;
39 import java.util.Map;
40
41 import org.apache.commons.beanutils.PropertyUtils;
42
43
44 /**
45 * Describes the type under the transformation. Can be used to customize the output of the transformation.
46 */
47 public class TypeDescriptor {
48
49 private Class<?> type;
50
51 private String itemType;
52
53 private Node2BeanTransformer transformer;
54
55 private boolean isMap;
56
57 private boolean isCollection;
58
59 private boolean isArray;
60
61 private Map<String, PropertyTypeDescriptor> descriptors;
62
63 public String getItemType() {
64 return this.itemType;
65 }
66
67 public void setItemType(String itemType) {
68 this.itemType = itemType;
69 }
70
71 public Class<?> getType() {
72 return this.type;
73 }
74
75 public void setType(Class<?> type) {
76 this.type = type;
77 }
78
79
80 public boolean isCollection() {
81 return this.isCollection;
82 }
83
84
85 public void setCollection(boolean isCollection) {
86 this.isCollection = isCollection;
87 }
88
89
90 public boolean isMap() {
91 return this.isMap;
92 }
93
94
95 public void setMap(boolean isMap) {
96 this.isMap = isMap;
97 }
98
99 public boolean isArray() {
100 return this.isArray;
101 }
102
103 public void setArray(boolean isArray) {
104 this.isArray = isArray;
105 }
106
107 public PropertyTypeDescriptor getPropertyTypeDescriptor(String propertyName, TypeMapping typeMapping) {
108 return getPropertyDescriptors(typeMapping).get(propertyName);
109 }
110
111 /**
112 * @return true if this descriptor represents an map or collection, without a concrete type thereof.
113 */
114 public boolean needsDefaultMapping() {
115 return (isMap() || isCollection()) && (getType().isInterface()) || isArray();
116 }
117
118 /**
119 * This method is not synchronized to avoid thread blocking, but the method guarantees that the returned map is not mutated afterward.
120 */
121 public Map<String, PropertyTypeDescriptor> getPropertyDescriptors(TypeMapping typeMapping) {
122 //TODO ---- moved this out to TypeDescriptorFactory or something ?
123 if (this.descriptors == null) {
124
125 // for not making this method synchronized we create a local variable first
126 // this guarantees that the map you get is not changed after return
127 final Map<String, PropertyTypeDescriptor> tmpDescriptors = new HashMap<>();
128 PropertyDescriptor[] dscrs = PropertyUtils.getPropertyDescriptors(this.getType());
129 for (PropertyDescriptor descriptor : dscrs) {
130 tmpDescriptors.put(descriptor.getName(), typeMapping.getPropertyTypeDescriptor(this.getType(), descriptor.getName()));
131 }
132
133 this.descriptors = Collections.unmodifiableMap(tmpDescriptors);
134 }
135 return this.descriptors;
136 }
137
138 /**
139 * Can return a custom transformer. Otherwise null.
140 */
141 public Node2BeanTransformer getTransformer() {
142 return transformer;
143 }
144
145 public void setTransformer(Node2BeanTransformer transformer) {
146 this.transformer = transformer;
147 }
148
149 }