/*
* Copyright 2008, Unitils.org
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.unitils.util;
import static org.apache.commons.lang.ClassUtils.getShortClassName;
import org.unitils.core.Module;
import org.unitils.core.UnitilsException;
import static org.unitils.util.PropertyUtils.containsProperty;
import static org.unitils.util.PropertyUtils.getString;
import static org.unitils.util.ReflectionUtils.getClassWithName;
import static org.unitils.util.ReflectionUtils.getEnumValue;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
/**
* Class containing utility methods for module specific configuration. Contains a method for retrieving all annotation
* property defaults ({@link #getAnnotationPropertyDefaults(Class,java.util.Properties,Class[])} ). The object that
* this method returns can later be used to get replace the default placeholder of an annotation property for the
* default value as configured in the unitils configuration.
*
* @author Tim Ducheyne
* @author Filip Neven
*/
public class ModuleUtils {
/**
* The default name of the default enum value.
*/
public static final String DEFAULT_ENUM_VALUE_NAME = "DEFAULT";
/**
* Returns an object that represents the default values for the properties of the given annotations and the given
* module.
*
* @param moduleClass The class of the module for which we want the default annotation property values
* @param configuration The unitils configuration
* @param annotationClasses The annotations for which we want the default values
* @return An object that returns the annotation property default values
*/
public static Map<Class<? extends Annotation>, Map<String, String>> getAnnotationPropertyDefaults(Class<? extends Module> moduleClass, Properties configuration, Class<? extends Annotation>... annotationClasses) {
Map<Class<? extends Annotation>, Map<String, String>> result = new HashMap<Class<? extends Annotation>, Map<String, String>>();
for (Class<? extends Annotation> annotationClass : annotationClasses) {
Method[] methods = annotationClass.getDeclaredMethods();
for (Method method : methods) {
String defaultValue = getAnnotationPropertyDefault(moduleClass, annotationClass, method.getName(), configuration);
Map<String, String> defaultValueMap = result.get(annotationClass);
if (defaultValueMap == null) {
defaultValueMap = new HashMap<String, String>();
result.put(annotationClass, defaultValueMap);
}
defaultValueMap.put(method.getName(), defaultValue);
}
}
return result;
}
/**
* Returns the default for annotation property of the given annotation with the given name for the given moduleclass.
*
* @param moduleClass The module class, not null
* @param annotationClass The annotation class, not null
* @param name The property suffix, not null
* @param configuration The unitils config, not null
* @return the default value
*/
public static String getAnnotationPropertyDefault(Class<? extends Module> moduleClass, Class<? extends Annotation> annotationClass, String name, Properties configuration) {
String propertyName = getShortClassName(moduleClass) + "." + getShortClassName(annotationClass) + "." + name + ".default";
if (!containsProperty(propertyName, configuration)) {
return null;
}
return getString(propertyName, configuration);
}
/**
* Replaces default enum value with the given default enum value.
* If enumValue contains the value {@link #DEFAULT_ENUM_VALUE_NAME} the defaultValue will be returned otherwise
* the enumValue itself will be returned.
*
* @param annotation the annotation, not null
* @param annotationPropertyName the name of the annotation property
* @param enumValue the value to check, not null
* @param allDefaultValues the map with values to return in case of a default, not null
* @return the enumValue or the defaultValue in case of a default
*/
public static <T extends Enum<?>> T getEnumValueReplaceDefault(Class<? extends Annotation> annotation, String annotationPropertyName, T enumValue, Map<Class<? extends Annotation>, Map<String, String>> allDefaultValues) {
return getEnumValueReplaceDefault(annotation, annotationPropertyName, enumValue, allDefaultValues, DEFAULT_ENUM_VALUE_NAME);
}
/**
* Replaces default enum value with the given default enum value.
* If enumValue contains the value {@link #DEFAULT_ENUM_VALUE_NAME} the defaultValue will be returned otherwise
* the enumValue itself will be returned.
*
* @param annotation the annotation, not null
* @param annotationPropertyName the name of the annotation property
* @param enumValue the value to check, not null
* @param allDefaultValues the map with values to return in case of a default, not null
* @param defaultValueName the name of the default value
* @return the enumValue or the defaultValue in case of a default
*/
@SuppressWarnings({"unchecked"})
public static <T extends Enum<?>> T getEnumValueReplaceDefault(Class<? extends Annotation> annotation, String annotationPropertyName, T enumValue, Map<Class<? extends Annotation>, Map<String, String>> allDefaultValues, String defaultValueName) {
String valueAsString = getValueAsStringReplaceDefault(annotation, annotationPropertyName, enumValue.name(), allDefaultValues, defaultValueName);
return (T) getEnumValue(enumValue.getClass(), valueAsString);
}
/**
* Replaces default enum value with the given default enum value.
* If enumValue contains the value {@link #DEFAULT_ENUM_VALUE_NAME} the defaultValue will be returned otherwise
* the enumValue itself will be returned.
*
* @param annotation the annotation, not null
* @param annotationPropertyName the name of the annotation property
* @param value the value to check, not null
* @param allDefaultValues the map with values to return in case of a default, not null
* @param defaultValueClass the name of the default value
* @return the enumValue or the defaultValue in case of a default
*/
public static Class<?> getClassValueReplaceDefault(Class<? extends Annotation> annotation, String annotationPropertyName, Class<?> value, Map<Class<? extends Annotation>, Map<String, String>> allDefaultValues, Class<?> defaultValueClass) {
String valueAsString = getValueAsStringReplaceDefault(annotation, annotationPropertyName, value.getName(), allDefaultValues, defaultValueClass.getName());
return getClassWithName(valueAsString);
}
/**
* Replaces default enum values with the given default enum value.
* If enumValue contains the value defaultValueName, the defaultValue will be returned otherwise
* the enumValue itself will be returned.
*
* @param annotation the annotation, not null
* @param annotationProperty the annotation property for which the value must be replaced, not null
* @param valueAsString the value to check, not null
* @param allDefaultValues the map with values to return in case of a default, not null
* @param defaultValueName the name of the default value, eg DEFAULT, not null @return the enumValue or the defaultValue in case of a default
* @return The default value as a string
*/
private static String getValueAsStringReplaceDefault(Class<? extends Annotation> annotation, String annotationProperty, String valueAsString, Map<Class<? extends Annotation>, Map<String, String>> allDefaultValues, String defaultValueName) {
if (!defaultValueName.equalsIgnoreCase(valueAsString)) {
// no replace needed
return valueAsString;
}
Map<String, String> defaultValues = allDefaultValues.get(annotation);
if (defaultValues != null) {
String defaultValueAsString = defaultValues.get(annotationProperty);
if (defaultValueAsString != null) {
return defaultValueAsString;
}
}
// nothing found, raise exception
throw new UnitilsException("Could not replace default value. No default value found for annotation: " + annotation + ", property " + annotationProperty + ", defaultValues: " + allDefaultValues);
}
}