com.googlecode.jmapper.annotations.Annotation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jmapper-core Show documentation
JMapper Framework is a java bean mapper based on javassist. JMapper exposes interesting features as relational mapping, dynamic conversions and more
The newest version!
/**
 * Copyright (C) 2012 - 2016 Alessandro Vurro.
 *
 * 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 com.googlecode.jmapper.annotations;

import static com.googlecode.jmapper.util.ClassesManager.getAllMethods;
import static com.googlecode.jmapper.util.GeneralUtility.isEmpty;
import static com.googlecode.jmapper.util.GeneralUtility.isNull;

import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;

import com.googlecode.jmapper.config.Constants;
import com.googlecode.jmapper.config.Error;
import com.googlecode.jmapper.conversions.explicit.ConversionMethod;
import com.googlecode.jmapper.exceptions.ConversionParameterException;
import com.googlecode.jmapper.exceptions.DynamicConversionBodyException;
import com.googlecode.jmapper.exceptions.DynamicConversionMethodException;
import com.googlecode.jmapper.exceptions.DynamicConversionParameterException;
import com.googlecode.jmapper.operations.beans.MappedField;
import com.googlecode.jmapper.xml.Converter;
import static com.googlecode.jmapper.util.ClassesManager.*;

/**
 * This is an utility class, the purpose is to centralize annotations handling.
 * @author Alessandro Vurro
 *
 */
public class Annotation {

	/**
	 * Fill target field with custom methods if occur all these conditions:

	 * 
	 * It's defined a JMapAccessor by configured field to target
	 * The target of the configuration hasn't the custom methods defined
	 * 
	 * @param configuredClass configured class
	 * @param configuredField configured field
	 * @param targetField target field
	 */
	public static void fillOppositeField(Class configuredClass, MappedField configuredField, MappedField targetField) {
		
		JMapAccessor accessor = getClassAccessors(configuredClass, targetField.getValue().getName(),true);
		
		if(isNull(accessor))
			accessor = getFieldAccessors(configuredClass, configuredField.getValue(),true, targetField.getValue().getName());
		
		if(isNull(accessor)) return;
		
		if(    targetField.getMethod().equals(Constants.DEFAULT_ACCESSOR_VALUE) 
			&& !accessor.get().equals(Constants.DEFAULT_ACCESSOR_VALUE))
			targetField.getMethod(accessor.get());
		
		if(    targetField.setMethod().equals(Constants.DEFAULT_ACCESSOR_VALUE) 
			&& !accessor.set().equals(Constants.DEFAULT_ACCESSOR_VALUE))
			targetField.setMethod(accessor.set());
			
	}
	
	/**
	 * Fill the MappedField given as input with the custom accessors (if defined).
	 * @param configuredClass field's class
	 * @param mappedField mapped field
	 */
	public static void fillMappedField(Class configuredClass, MappedField mappedField){
		
		JMapAccessor accessor = getClassAccessors(configuredClass, mappedField.getValue().getName(),false);
		
		if(isNull(accessor))
			accessor = getFieldAccessors(configuredClass,mappedField.getValue());
		
		if(isNull(accessor)) return;
			
		if(    mappedField.getMethod().equals(Constants.DEFAULT_ACCESSOR_VALUE)
			&& !accessor.get().equals(Constants.DEFAULT_ACCESSOR_VALUE))
			mappedField.getMethod(accessor.get());
			
		if(     mappedField.setMethod().equals(Constants.DEFAULT_ACCESSOR_VALUE)
			&& !accessor.set().equals(Constants.DEFAULT_ACCESSOR_VALUE))
			mappedField.setMethod(accessor.set());
			
	}
	
	/**
	 * Returns JMapAccessor relative to this field, null if not present.
	 * @param clazz field's class
	 * @param field to check
	 * @return JMapAccessor if exists, null otherwise
	 */
	public static JMapAccessor getFieldAccessors(Class clazz, Field field){
		return getFieldAccessors(clazz,field,false, field.getName(),Constants.DEFAULT_FIELD_VALUE);
	}
	
	/**
	 * Checks if this field contains a definition of accessors for the name given as input.
	 * @param clazz class to check
	 * @param field field to check
	 * @param isOpposite true if accessor methods to check belong to the opposite field, false otherwise
	 * @param fieldNames name to find
	 * @return JMapAccessor if exists, null otherwise
	 */
	private static JMapAccessor getFieldAccessors(Class clazz, Field field,boolean isOpposite, String... fieldNames){
		for (String fieldName : fieldNames) {
			JMapAccessor accessor = getAccessor(clazz,field.getAnnotations(),fieldName,isOpposite);
			if(!isNull(accessor)) return accessor;
		}
		return null;
	}
	
	/**
	 * Checks if this field contains a definition of accessors for the name given as input.
	 * @param clazz class to check
	 * @param fieldName name to find
	 * @param isOpposite true if accessor methods to check belong to the opposite field, false otherwise
	 * @return JMapAccessor if exists, null otherwise
	 */
	public static JMapAccessor getClassAccessors(Class clazz, String fieldName, boolean isOpposite){
		return getAccessor(clazz, clazz.getAnnotations(),fieldName,isOpposite);
	}
	
	/**
	 * It finds between annotations if exists a JMapAccessor relative to the field with this name.
	 * @param annotations annotations to check
	 * @param fieldName field name
	 * @param isOpposite true if accessor methods to check belong to the opposite field, false otherwise
	 * @return JMapAccessor if exists, null otherwise
	 */
	private static JMapAccessor getAccessor(Class clazz, java.lang.annotation.Annotation[] annotations, String fieldName, boolean isOpposite){
		for (java.lang.annotation.Annotation annotation : annotations) {
			if(annotation.annotationType() == JMapAccessors.class){
				JMapAccessors jmapAccessors = (JMapAccessors)annotation;
				for (JMapAccessor jmapAccessor : jmapAccessors.value()) 
					if(isValid(jmapAccessor,fieldName,clazz,isOpposite)) return jmapAccessor;
				
			}
			if(annotation.annotationType() == JMapAccessor.class){
				JMapAccessor jmapAccessor = (JMapAccessor)annotation;
					if(isValid(jmapAccessor,fieldName,clazz,isOpposite)) return jmapAccessor;
			}
		}
		return null;
	}
	
	/**
	 * @param accessor accessor to analyze
	 * @param fieldName field to check
	 * @param targetClass class to check
	 * @param isOpposite true if this accessor describe target field
	 * @return True if this accessor meets the criteria, false otherwise
	 */
	private static boolean isValid(JMapAccessor accessor, String fieldName, Class targetClass, boolean isOpposite){

		if(isEmpty(accessor.classes())) 
			return accessor.name().equals(fieldName);
		
		for (Class mappedClass : accessor.classes()) 
			if(accessor.name().equals(fieldName))
				if(isOpposite){
					if(mappedClass != targetClass)
						return true;
				}else
					if(mappedClass == targetClass)
						return true;
		
		return false;
	}
	
	/**
	 * Returns a list of ConversionMethod that belong to the class given as input.
	 * @param clazz class to check
	 * @return a list of conversionMethod
	 */
	public static List getConversionMethods(Class clazz){
		List conversions = new ArrayList();
		
			for(Method method:getAnnotatedMethods(clazz))
				try{   conversions.add(Converter.toConversionMethod(method));
				}catch (ConversionParameterException e) {
					Error.wrongParameterNumber(method.getName(),clazz.getSimpleName());
				}catch (DynamicConversionParameterException e) {
					Error.parametersUsageNotAllowed(method.getName(), clazz.getSimpleName());
				}catch (DynamicConversionMethodException e) {
					Error.incorrectMethodDefinition(method.getName(), clazz.getSimpleName());
				}catch (DynamicConversionBodyException e) {
					Error.incorrectBodyDefinition(method.getName(), clazz.getSimpleName());
				}
		return conversions;
	}
	
	/**
	 * Returns a list with all annotated methods.
	 * @param clazz class to check
	 * @return a list with all annotated methods
	 */
	private static List getAnnotatedMethods(Class clazz){
		List methods = new ArrayList();
		
		for(Method method:getAllMethods(clazz))
			if(!isNull(method.getAnnotation(JMapConversion.class)))
				methods.add(method);
		
		return methods;
	}
	
	/**
	 * Returns true if the class is configured in annotation, false otherwise.
	 * @param classToCheck class to check
	 * @return true if the class is configured in annotation, false otherwise
	 */
	public static boolean isInheritedMapped(Class classToCheck){
		
		for (Class clazz : getAllsuperClasses(classToCheck)) 
			if(!isNull(clazz.getAnnotation(JGlobalMap.class))) 
				return true;

		for (Field field : getListOfFields(classToCheck)) 
			if(!isNull(field.getAnnotation(JMap.class))) 
				return true;
		
		return false;
	}
	
}