/*
* JBoss, Home of Professional Open Source
* Copyright 2006, JBoss Inc., and individual contributors as indicated
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.kernel.plugins.annotations;
import java.lang.annotation.Annotation;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import org.jboss.beans.metadata.plugins.AbstractBeanMetaData;
import org.jboss.beans.metadata.plugins.AbstractPropertyMetaData;
import org.jboss.beans.metadata.spi.BeanMetaData;
import org.jboss.beans.metadata.spi.MetaDataVisitorNode;
import org.jboss.beans.metadata.spi.PropertyMetaData;
import org.jboss.beans.metadata.spi.ValueMetaData;
import org.jboss.reflect.spi.AnnotatedInfo;
import org.jboss.reflect.spi.ParameterInfo;
import org.jboss.reflect.spi.TypeInfo;
/**
* Injectable member annotation plugin.
*
* @param <T> the annotated info
* @param <C> annotation type
* @author <a href="mailto:ales.justin@jboss.com">Ales Justin</a>
*/
public abstract class InjectableMemberAnnotationPlugin<T extends AnnotatedInfo, C extends Annotation> extends AbstractAnnotationPlugin<T, C>
{
protected InjectableMemberAnnotationPlugin(Class<C> annotation)
{
super(annotation);
}
/**
* Get the annotated info name.
*
* @param info the info
* @return info's name
*/
protected abstract String getName(T info);
/**
* Find matching property metadata.
*
* @param info the property info
* @param beanMetaData the bean metadata
* @return matching property metadata or null
*/
protected PropertyMetaData findPropertyMetaData(T info, BeanMetaData beanMetaData)
{
Set<PropertyMetaData> properties = beanMetaData.getProperties();
if (properties != null && properties.isEmpty() == false)
{
for(PropertyMetaData pmd : properties)
{
if (pmd.getName().equals(getName(info)))
return pmd;
}
}
return null;
}
protected boolean isMetaDataAlreadyPresent(T info, C annotation, BeanMetaData beanMetaData)
{
PropertyMetaData pmd = findPropertyMetaData(info, beanMetaData);
return isMetaDataComplete(pmd);
}
/**
* Is property metadata complete.
*
* @param pmd the property meta data
* @return true if metadata is complete
*/
protected boolean isMetaDataComplete(PropertyMetaData pmd)
{
return (pmd != null);
}
protected List<? extends MetaDataVisitorNode> internalApplyAnnotation(T info, C annotation, BeanMetaData beanMetaData) throws Throwable
{
Set<PropertyMetaData> properties = getProperties(beanMetaData);
PropertyMetaData property = getPropertyMetaData(info, annotation, beanMetaData);
properties.add(property);
return Collections.singletonList(property);
}
/**
* Get PropertyMetaData instance.
*
* @param info the info
* @param annotation the annotation
* @param beanMetaData the bean metadata
* @return get new PropertyMetaData instance
*/
protected PropertyMetaData getPropertyMetaData(T info, C annotation, BeanMetaData beanMetaData)
{
return getPropertyMetaData(info, annotation);
}
/**
* Get PropertyMetaData instance.
*
* @param info the info
* @param annotation the annotation
* @return get new PropertyMetaData instance
*/
protected PropertyMetaData getPropertyMetaData(T info, C annotation)
{
ValueMetaData value = createValueMetaData(info, annotation);
if (value == null)
throw new IllegalArgumentException("Should not return null value, " + this);
return new AbstractPropertyMetaData(getName(info), value);
}
/**
* Get the PropertyMetaData set.
*
* @param beanMetaData the bean meta data
* @return set of existing PropertyMetaData
*/
protected Set<PropertyMetaData> getProperties(BeanMetaData beanMetaData)
{
Set<PropertyMetaData> properties = beanMetaData.getProperties();
if (properties == null)
{
properties = new HashSet<PropertyMetaData>();
AbstractBeanMetaData bean = checkIfNotAbstractBeanMetaDataSpecific(beanMetaData);
bean.setProperties(properties);
}
return properties;
}
/**
* Create value meta data.
*
* @param parameterInfo the parameter ifo
* @param annotation the annotation
* @param previousValue previous value
* @return value meta data
*/
public ValueMetaData createValueMetaData(ParameterInfo parameterInfo, C annotation, ValueMetaData previousValue)
{
return createValueMetaData(parameterInfo.getParameterType(), annotation, previousValue);
}
/**
* Create value metadata.
*
* @param type the type info
* @param annotation the annotation
* @param previousValue the previous value
* @return value metadata instance
*/
protected ValueMetaData createValueMetaData(TypeInfo type, C annotation, ValueMetaData previousValue)
{
return createValueMetaData(type, annotation);
}
/**
* Create value metadata.
*
* @param type the type info
* @param annotation the annotation
* @return value metadata instance
*/
protected ValueMetaData createValueMetaData(TypeInfo type, C annotation)
{
return createValueMetaData(annotation, null);
}
/**
* Create value meta data.
*
* @param info the info
* @param annotation the annotation
* @return value metadata
*/
protected ValueMetaData createValueMetaData(T info, C annotation)
{
return createValueMetaData(annotation, null);
}
/**
* Create value meta data.
*
* @param annotation the annotation
* @param previousValue previous value
* @return value meta data
*/
protected ValueMetaData createValueMetaData(C annotation, ValueMetaData previousValue)
{
return createValueMetaData(annotation);
}
/**
* Create value meta data.
*
* @param annotation the annotation
* @return value meta data
*/
public ValueMetaData createValueMetaData(C annotation)
{
throw new IllegalArgumentException("Missing createValueMetaData(" + annotation + ") implementation: " + toString());
}
}