net.officefloor.web.value.retrieve.PropertyMetaData Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of officeweb Show documentation
OfficeFloor plug-in for Web
There is a newer version: 3.40.0
/*
 * OfficeFloor - http://www.officefloor.net
 * Copyright (C) 2005-2018 Daniel Sagenschneider
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */
package net.officefloor.web.value.retrieve;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

/**
 * Meta-data for the property.
 * 
 * @author Daniel Sagenschneider
 */
public class PropertyMetaData {

	/**
	 * Property name.
	 */
	private final String propertyName;

	/**
	 * {@link Method} for the type.
	 */
	private final Method typeMethod;

	/**
	 * Mapping of {@link Method} to the particular type.
	 */
	private final Map, Method> typeToMethod = new ConcurrentHashMap, Method>();

	/**
	 * Properties on the resulting property object.
	 */
	private final PropertyMetaData[] properties;

	/**
	 * Initiate.
	 * 
	 * @param propertyName
	 *            Property name.
	 * @param typeMethod
	 *            {@link Method} for the type.
	 * @param properties
	 *            Properties on the resulting property object.
	 */
	public PropertyMetaData(String propertyName, Method typeMethod, PropertyMetaData[] properties) {
		this.propertyName = propertyName;
		this.typeMethod = typeMethod;
		this.properties = properties;
	}

	/**
	 * Obtains the property name.
	 * 
	 * @return Property name.
	 */
	public String getPropertyName() {
		return this.propertyName;
	}

	/**
	 * 
	 * Obtains the type {@link Method}.
	 * 

	 * This is the {@link Method} base on the type and may be abstract.
	 * 
	 * @return Type {@link Method}.
	 */
	public Class getValueType() {
		return this.typeMethod.getReturnType();
	}

	/**
	 * 
	 * Obtains the value {@link Annotation}.
	 * 
	 * @param 
	 *            {@link Annotation} type.
	 * @param annotationType
	 *            {@link Annotation}.
	 * @return {@link Annotation} or null.
	 */
	@SuppressWarnings("unchecked")
	public  A getValueAnnotation(Class annotationType) {

		// Ensure annotation type
		if (!(Annotation.class.isAssignableFrom(annotationType))) {
			return null; // must be annoation type
		}

		// Obtain the annotation
		Class annotationClass = (Class) annotationType;
		return (A) this.typeMethod.getAnnotation(annotationClass);
	}

	/**
	 * Obtains the {@link Method}.
	 * 
	 * @param type
	 *            Type to obtain the {@link Method}.
	 * @return {@link Method}.
	 * @throws Exception
	 *             If fails to obtain the {@link Method}.
	 */
	public Method getMethod(Class type) throws Exception {

		// Lazy obtain the method
		Method method = this.typeToMethod.get(type);
		if (method == null) {
			method = type.getMethod(this.typeMethod.getName());
			this.typeToMethod.put(type, method);
		}

		// Return the method
		return method;
	}

	/**
	 * Obtains the Properties on the resulting property object.
	 * 
	 * @return Properties on the resulting property object.
	 */
	public PropertyMetaData[] getProperties() {
		return this.properties;
	}

}