com.agimatec.annotations.jam.JAMTestAnnotatedElement Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of annomark Show documentation
There is a newer version: 2.5.11
package com.agimatec.annotations.jam;

import org.codehaus.jam.JAnnotatedElement;
import org.codehaus.jam.JAnnotation;
import org.codehaus.jam.JClass;
import org.codehaus.jam.JField;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * Description: 

 * User: roman.stumm 

 * Date: 08.06.2007 

 * Time: 12:10:31 

 * Copyright: Agimatec GmbH
 */
public abstract class JAMTestAnnotatedElement {
    private final Map annotations = new HashMap();

    public abstract String getName();

    public abstract String getType();

    public abstract JClass getTypeJClass();

    public abstract JAMTestClass getTestClass();

    public JAMAnnotation getAnnotation(String anno) {
        JAMAnnotation ja = annotations.get(anno);
        if (ja == null) {
            JAnnotation a = element().getAnnotation(anno);
            if (a != null) {
                ja = new JAMAnnotation(a);
                annotations.put(anno, ja);
            }
        }
        return ja;
    }

    protected abstract JAnnotatedElement element();

    protected String stringValue(String v, String defaultValue) {
        return v == null || v.length() == 0 ? defaultValue : v;
    }

    public String getComment() {
        if (element().getComment() == null) return null;
        String c = element().getComment().getText();
        return c == null || c.length() == 0 ? null : c;
    }

    protected boolean isCurrentlyActive(JAMAnnotation ja) {
        return true;
     }

    /**
     * the first active Test annotation or null
     * @return
     */
    public JAMAnnotation getTestAnnotation() {
        JAMAnnotation ja = getAnnotation(singleAnnotation());
        if (ja == null) {
            ja = getAnnotation(multiAnnotation());
            if (ja != null) {
                for (JAMAnnotation each : ja.getAnnotationArray()) {
                    if (isCurrentlyActive(each)) {
                        return each;
                    }
                }
            }
            return null;
        } else {
            return (isCurrentlyActive(ja)) ? ja : null;
        }
    }

    /**
     * all active Test annotations or null
     * @return
     */
    public JAMAnnotation[] getTestAnnotations() {
        JAMAnnotation ja = getAnnotation(singleAnnotation());
        if (ja == null) {
            ja = getAnnotation(multiAnnotation());
            if (ja != null) {
                List activeAnnotations = new ArrayList(ja.getAnnotationArray().length);
                for (JAMAnnotation each : ja.getAnnotationArray()) {
                    if (isCurrentlyActive(each)) {
                        activeAnnotations.add(each);
                    }
                }
                return activeAnnotations.toArray(new JAMAnnotation[activeAnnotations.size()]);
            }
            return null;
        } else {
            return (isCurrentlyActive(ja)) ? new JAMAnnotation[]{ja} : null;
        }
    }

    protected abstract String singleAnnotation();
    protected abstract String multiAnnotation();

    public boolean isTestCurrentlyActive() {
        return getTestAnnotation() != null;
    }

    public String toString() {
        return element().toString();
    }

    public abstract String getType(String testPath);

    protected static JField findField(JField root, String each) {
        return findField(root.getType(), each);
    }

    protected static JField findField(JClass rootCls, String each) {
        JField[] fields = rootCls.getFields();
        for (JField field : fields) {
            if (field.getSimpleName().equals(each)) return field;
        }
        return null;
    }

}