ClassScanner.java

/*
 * *************************************************************************************************************************************************************
 *
 * TheseFoolishThings: Miscellaneous utilities
 * http://tidalwave.it/projects/thesefoolishthings
 *
 * Copyright (C) 2009 - 2024 by Tidalwave s.a.s. (http://tidalwave.it)
 *
 * *************************************************************************************************************************************************************
 *
 * 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.
 *
 * *************************************************************************************************************************************************************
 *
 * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
 * git clone https://github.com/tidalwave-it/thesefoolishthings-src
 *
 * *************************************************************************************************************************************************************
 */
package it.tidalwave.util.spring;

import java.lang.annotation.Annotation;
import javax.annotation.Nonnull;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider;
import org.springframework.core.type.filter.AnnotationTypeFilter;
import org.springframework.core.type.filter.TypeFilter;
import org.springframework.util.ClassUtils;
import it.tidalwave.role.spring.RoleSpringConfiguration;
import lombok.Setter;

/***************************************************************************************************************************************************************
 *
 * A utility for scanning classes in the classpath with some criteria.
 *
 * @author  Fabrizio Giudici
 *
 **************************************************************************************************************************************************************/
public class ClassScanner
  {
    @Setter
    private static String basePackages = System.getProperty(
            ClassScanner.class.getCanonicalName() + ".basePackages", RoleSpringConfiguration.getBasePackages());

    private final ClassPathScanningCandidateComponentProvider scanner =
            new ClassPathScanningCandidateComponentProvider(false);

    /***********************************************************************************************************************************************************
     * Scans for classes and returns them.
     *
     * @return  the collection of scanned classes
     **********************************************************************************************************************************************************/
    @Nonnull
    public final Collection<Class<?>> findClasses()
      {
        final List<Class<?>> classes = new ArrayList<>();

        for (final var basePackage : basePackages.split(":"))
          {
            for (final var candidate : scanner.findCandidateComponents(basePackage))
              {
                classes.add(ClassUtils.resolveClassName(candidate.getBeanClassName(),
                            ClassUtils.getDefaultClassLoader()));
              }
          }

        return classes;
      }

    /***********************************************************************************************************************************************************
     * Adds an "include" filter.
     *
     * @param  filter   the filter
     * @return          itself for method chaining
     **********************************************************************************************************************************************************/
    @Nonnull
    public ClassScanner withIncludeFilter (@Nonnull final TypeFilter filter)
      {
        scanner.addIncludeFilter(filter);
        return this;
      }

    /***********************************************************************************************************************************************************
     * Adds a filter for an annotation.
     *
     * @param  annotationClass  the annotation class
     * @return                  itself for method chaining
     **********************************************************************************************************************************************************/
    @Nonnull
    public ClassScanner withAnnotationFilter (@Nonnull final Class<? extends Annotation> annotationClass)
      {
        return withIncludeFilter(new AnnotationTypeFilter(annotationClass));
      }
  }