edu.cmu.tetrad.annotation.AbstractAnnotations Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of tetrad-lib Show documentation
There is a newer version: 7.6.4
/*
 * Copyright (C) 2017 University of Pittsburgh.
 *
 * This library 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 library 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 library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301  USA
 */
package edu.cmu.tetrad.annotation;

import org.reflections.Reflections;

import java.lang.annotation.Annotation;
import java.util.Collections;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;

/**
 * Abstract class for annotations.
 *
 * Sep 20, 2017 10:59:43 AM
 *
 * @param  annotation type
 * @author Kevin V. Bui ([email protected])
 */
public abstract class AbstractAnnotations {

    /**
     * Annotated classes.
     */
    protected final List> annotatedClasses;

    /**
     * Constructor.
     * @param packageName package name
     * @param type annotation type
     */
    public AbstractAnnotations(String packageName, Class type) {
        Reflections reflections = new Reflections(packageName);
        Set> classes = reflections.getTypesAnnotatedWith(type);

        this.annotatedClasses = classes.parallelStream()
                .map(e -> new AnnotatedClass<>(e, e.getAnnotation(type)))
                .collect(Collectors.toList());
    }

    /**
     * Get annotated classes.
     * @return annotated classes
     */
    public List> getAnnotatedClasses() {
        return Collections.unmodifiableList(this.annotatedClasses);
    }

    /**
     * Filter annotated classes by annotation type.
     * @param annoClasses annotated classes
     * @param type annotation type
     * @return filtered annotated classes
     */
    public List> filterByAnnotation(List> annoClasses, Class type) {
        if (annoClasses == null || type == null) {
            return Collections.EMPTY_LIST;
        }

        List> list = annoClasses.stream()
                .filter(e -> e.getClazz().isAnnotationPresent(type))
                .collect(Collectors.toList());

        return Collections.unmodifiableList(list);
    }

    /**
     * Filter out annotated classes by annotation type.
     * @param annoClasses annotated classes
     * @param type annotation type
     * @return filtered annotated classes
     */
    public List> filterOutByAnnotation(List> annoClasses, Class type) {
        if (annoClasses == null || type == null) {
            return Collections.EMPTY_LIST;
        }

        List> list = annoClasses.stream()
                .filter(e -> !e.getClazz().isAnnotationPresent(type))
                .collect(Collectors.toList());

        return Collections.unmodifiableList(list);
    }

}