io.quarkiverse.operatorsdk.common.ClassUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of quarkus-operator-sdk-common-deployment Show documentation
The newest version!
package io.quarkiverse.operatorsdk.common;

import static io.quarkiverse.operatorsdk.common.Constants.ANNOTATION_CONFIGURABLE;
import static io.quarkiverse.operatorsdk.common.Constants.CUSTOM_RESOURCE;
import static io.quarkiverse.operatorsdk.common.Constants.DEPENDENT_RESOURCE;
import static io.quarkiverse.operatorsdk.common.Constants.OBJECT;
import static io.quarkiverse.operatorsdk.common.Constants.RECONCILER;

import java.util.Collections;
import java.util.Map;
import java.util.stream.Stream;

import org.jboss.jandex.ClassInfo;
import org.jboss.jandex.DotName;
import org.jboss.jandex.IndexView;
import org.jboss.jandex.Type;
import org.jboss.logging.Logger;

public class ClassUtils {

    private ClassUtils() {
    }

    public static boolean isStatusNotVoid(String statusClassName) {
        return !Void.class.getName().equals(statusClassName);
    }

    /**
     * Only retrieve {@link io.javaoperatorsdk.operator.api.reconciler.Reconciler} implementations that should be considered by
     * the extension, excluding the SDK's own implementations and non-processable (i.e. reconcilers that are not correctly
     * parameterized) ones.
     *
     * @param index the {@link IndexView} used to retrieve class informations
     * @param log a {@link Logger} used to output skipped reconcilers information
     * @return a stream of {@link ReconcilerAugmentedClassInfo} providing information about processable reconcilers
     */
    public static Stream getKnownReconcilers(IndexView index, Logger log) {
        return getProcessableImplementationsOf(RECONCILER, index, log, Collections.emptyMap())
                .map(ReconcilerAugmentedClassInfo.class::cast);
    }

    public static Stream getProcessableImplementationsOf(DotName interfaceType,
            IndexView index, Logger log, Map context) {
        return getProcessableImplementationsOrExtensionsOf(interfaceType, index, log, context, true);
    }

    public static Stream getProcessableSubClassesOf(DotName classType,
            IndexView index, Logger log, Map context) {
        return getProcessableImplementationsOrExtensionsOf(classType, index, log, context, false);
    }

    private static Stream getProcessableImplementationsOrExtensionsOf(
            DotName implementedOrExtendedClass,
            IndexView index, Logger log, Map context, boolean isInterface) {
        final var extensions = isInterface ? index.getAllKnownImplementors(implementedOrExtendedClass)
                : index.getAllKnownSubclasses(implementedOrExtendedClass);
        return extensions.stream()
                .map(classInfo -> createAugmentedClassInfoFor(implementedOrExtendedClass, classInfo))
                .filter(fci -> fci.keep(index, log, context))
                .peek(fci -> fci.augmentIfKept(index, log, context));
    }

    static SelectiveAugmentedClassInfo createAugmentedClassInfoFor(DotName implementedOrExtendedClass, ClassInfo classInfo) {
        if (RECONCILER.equals(implementedOrExtendedClass)) {
            return new ReconcilerAugmentedClassInfo(classInfo);
        } else if (DEPENDENT_RESOURCE.equals(implementedOrExtendedClass)) {
            return new DependentResourceAugmentedClassInfo(classInfo);
        } else if (ANNOTATION_CONFIGURABLE.equals(implementedOrExtendedClass)) {
            return new AnnotationConfigurableAugmentedClassInfo(classInfo);
        } else if (CUSTOM_RESOURCE.equals(implementedOrExtendedClass)) {
            return new CustomResourceAugmentedClassInfo(classInfo, null);
        } else {
            throw new IllegalArgumentException("Don't know how to process " + implementedOrExtendedClass);
        }
    }

    /**
     * Determines whether the class represented by the specified {@link ClassInfo} implements the specified target interface.
     * Note that this only checks whether the target interface is directly implemented by any of the classes reachable from the
     * specified class. This won't examine whether the target interface is indirectly reachable (via e.g. interface
     * hierarchies).
     *
     * @param index the {@link IndexView} used to retrieve class information
     * @param info the {@link ClassInfo} associated with the class we want to examine
     * @param targetInterface the target interface name
     * @return {@code true} if the specified {@link ClassInfo} or one of its super-types directly implements the target
     *         interface, {@code false} otherwise
     */
    public static boolean isImplementationOf(IndexView index, ClassInfo info, DotName targetInterface) {
        if (info.interfaceNames().contains(targetInterface)) {
            return true;
        } else {

            // move up the type hierarchy
            Type superType = info.superClassType();

            // if we've reached Object, our class doesn't implement the target interface
            final var superTypeName = superType.name();
            if (OBJECT.equals(superTypeName)) {
                return false;
            }
            ClassInfo superClass = index.getClassByName(superTypeName);
            if (superClass == null) {
                throw new IllegalStateException("The class " + superTypeName + " is not inside the Jandex index");
            } else {
                return isImplementationOf(index, superClass, targetInterface);
            }
        }
    }

    public static boolean hasField(IndexView index, ClassInfo info, String fieldName) {
        ClassInfo tmpClassInfo = info;
        while (tmpClassInfo != null) {
            final var status = tmpClassInfo.field(fieldName);
            if (status != null) {
                return true;
            }
            // look up the hierarchy
            if (tmpClassInfo.superName() != null) {
                tmpClassInfo = index.getClassByName(tmpClassInfo.superName());
            } else {
                tmpClassInfo = null;
            }
        }
        return false;
    }
}