com.pi4j.util.ReflectionUtil Maven / Gradle / Ivy

Go to download
package com.pi4j.util;

/*-
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: LIBRARY  :: Java Library (CORE)
 * FILENAME      :  ReflectionUtil.java
 *
 * This file is part of the Pi4J project. More information about
 * this project can be found here:  https://pi4j.com/
 * **********************************************************************
 *
 * 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.
 * #L%
 */

import java.util.Collection;
import java.util.Comparator;
import java.util.HashSet;
import java.util.Set;
import java.util.stream.Collectors;

/**
 * ReflectionUtil class.
 *
 * @author Robert Savage (http://www.savagehomeautomation.com)
 * @version $Id: $Id
 */
public class ReflectionUtil {

    /**
     * getAllInterfacesSorted.  Interfaces are sorted by full qualified class name.
     *
     * @param target a {@link java.lang.Object} object.
     * @return a sorted {@link java.util.Collection} object.
     */
    public static Collection getAllInterfacesSorted(Object target){
        return getAllInterfaces(target.getClass())
            .stream()
            .sorted(Comparator.comparing(Class::getName))
            .collect(Collectors.toList());
    }

    /**
     * getAllInterfaces.
     *
     * @param target a {@link java.lang.Object} object.
     * @return a {@link java.util.Collection} object.
     */
    public static Collection getAllInterfaces(Object target){
        return getAllInterfaces(target.getClass());
    }

    /**
     * getAllInterfaces.
     *
     * @param targetClass a {@link java.lang.Class} object.
     * @return a {@link java.util.Collection} object.
     */
    public static Collection getAllInterfaces(Class targetClass){
        Set results = new HashSet<>();

        // get all direct interfaces and their parents
        for(Class ifc : targetClass.getInterfaces()){
            results.add(ifc);
            results.addAll(getAllInterfaces(ifc));
        }

        // get all super classes and their interfaces
        if(targetClass.getSuperclass() != null){
            results.addAll(getAllInterfaces(targetClass.getSuperclass()));
        }

        // get all direct interfaces and their parents
        for(Class ifc : targetClass.getInterfaces()){
            if(ifc.getSuperclass() != null){
                results.addAll(getAllInterfaces(ifc.getSuperclass()));
            }
        }
        return results;
    }

    /**
     * getAllClasses.
     *
     * @param target a {@link java.lang.Object} object.
     * @return a {@link java.util.Collection} object.
     */
    public static Collection getAllClasses(Object target){
        Set results = new HashSet<>();
        return getAllClasses(target.getClass());
    }

    /**
     * getAllClasses.
     *
     * @param targetClass a {@link java.lang.Class} object.
     * @return a {@link java.util.Collection} object.
     */
    public static Collection getAllClasses(Class targetClass){
        Set results = new HashSet<>();

        results.add(targetClass);

        // get all super classes and their interfaces
        if(targetClass.getSuperclass() != null){
            results.add(targetClass.getSuperclass());
            results.addAll(getAllClasses(targetClass.getSuperclass()));
        }

        return results;
    }

}