1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * https://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.validator.util;
18
19 import java.util.Collection;
20 import java.util.HashMap;
21 import java.util.Iterator;
22 import java.util.Map;
23 import java.util.Map.Entry;
24
25 import org.apache.commons.beanutils.PropertyUtils;
26 import org.apache.commons.collections.FastHashMap; // DEPRECATED
27 import org.apache.commons.logging.Log;
28 import org.apache.commons.logging.LogFactory;
29 import org.apache.commons.validator.Arg;
30 import org.apache.commons.validator.Msg;
31 import org.apache.commons.validator.Var;
32
33 /**
34 * Basic utility methods.
35 * <p>
36 * The use of FastHashMap is deprecated and will be replaced in a future
37 * release.
38 * </p>
39 */
40 public class ValidatorUtils {
41
42 private static final Log LOG = LogFactory.getLog(ValidatorUtils.class);
43
44 /**
45 * Makes a deep copy of a {@code FastHashMap} if the values
46 * are {@code Msg}, {@code Arg},
47 * or {@code Var}. Otherwise, it is a shallow copy.
48 *
49 * @param fastHashMap {@code FastHashMap} to copy.
50 * @return FastHashMap A copy of the {@code FastHashMap} that was
51 * passed in.
52 * @deprecated This method is not part of Validator's public API. Validator
53 * will use it internally until FastHashMap references are removed. Use
54 * copyMap() instead.
55 */
56 @Deprecated
57 public static FastHashMap copyFastHashMap(final FastHashMap fastHashMap) {
58 final FastHashMap results = new FastHashMap();
59 @SuppressWarnings("unchecked") // FastHashMap is not generic
60 final Iterator<Entry<String, ?>> iterator = fastHashMap.entrySet().iterator();
61 while (iterator.hasNext()) {
62 final Entry<String, ?> entry = iterator.next();
63 final String key = entry.getKey();
64 final Object value = entry.getValue();
65 if (value instanceof Msg) {
66 results.put(key, ((Msg) value).clone());
67 } else if (value instanceof Arg) {
68 results.put(key, ((Arg) value).clone());
69 } else if (value instanceof Var) {
70 results.put(key, ((Var) value).clone());
71 } else {
72 results.put(key, value);
73 }
74 }
75 results.setFast(true);
76 return results;
77 }
78
79 /**
80 * Makes a deep copy of a {@link Map} if the values are
81 * {@code Msg}, {@code Arg}, or {@code Var}. Otherwise,
82 * it is a shallow copy.
83 *
84 * @param map The source Map to copy.
85 * @return A copy of the {@link Map} that was passed in.
86 */
87 public static Map<String, Object> copyMap(final Map<String, Object> map) {
88 final Map<String, Object> results = new HashMap<>(map.size());
89 map.forEach((key, value) -> {
90 if (value instanceof Msg) {
91 results.put(key, ((Msg) value).clone());
92 } else if (value instanceof Arg) {
93 results.put(key, ((Arg) value).clone());
94 } else if (value instanceof Var) {
95 results.put(key, ((Var) value).clone());
96 } else {
97 results.put(key, value);
98 }
99 });
100 return results;
101 }
102
103 /**
104 * Convenience method for getting a value from a bean property as a
105 * {@link String}. If the property is a {@code String[]} or
106 * {@link Collection} and it is empty, an empty {@link String}
107 * "" is returned. Otherwise, property.toString() is returned. This method
108 * may return {@code null} if there was an error retrieving the
109 * property.
110 *
111 * @param bean The bean object.
112 * @param property The name of the property to access.
113 * @return The value of the property.
114 */
115 public static String getValueAsString(final Object bean, final String property) {
116 Object value = null;
117
118 try {
119 value = PropertyUtils.getProperty(bean, property);
120
121 } catch (final ReflectiveOperationException e) {
122 LOG.error(e.getMessage(), e);
123 }
124
125 if (value == null) {
126 return null;
127 }
128
129 if (value instanceof String[]) {
130 return ((String[]) value).length > 0 ? value.toString() : "";
131
132 }
133 if (value instanceof Collection) {
134 return ((Collection<?>) value).isEmpty() ? "" : value.toString();
135
136 }
137 return value.toString();
138
139 }
140
141 /**
142 * <p>Replace part of a {@link String} with another value.</p>
143 *
144 * @param value {@link String} to perform the replacement on.
145 * @param key The name of the constant.
146 * @param replaceValue The value of the constant.
147 * @return The modified value.
148 */
149 public static String replace(final String value, final String key, final String replaceValue) {
150 if (value == null || key == null || replaceValue == null) {
151 return value;
152 }
153 return value.replace(key, replaceValue);
154 }
155
156 /**
157 * Constructs a new instance.
158 *
159 * @deprecated Will be private in the next major version.
160 */
161 @Deprecated
162 public ValidatorUtils() {
163 // empty
164 }
165
166 }