com.github.czyzby.kiwi.util.gdx.reflection.Annotations Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gdx-kiwi Show documentation

Guava-inspired set of utilities for LibGDX.

There is a newer version: 1.9.1.9.6

package com.github.czyzby.kiwi.util.gdx.reflection;

import com.badlogic.gdx.utils.reflect.Annotation;
import com.badlogic.gdx.utils.reflect.ClassReflection;
import com.github.czyzby.kiwi.util.common.Exceptions;
import com.github.czyzby.kiwi.util.common.UtilitiesClass;

/** Utilities for LibGDX annotation processing.
 *
 * @author MJ
 * @see Reflection */
public class Annotations extends UtilitiesClass {
    private Annotations() {
    }

    /** @param classToProcess will be validated.
     * @return true if the class has at least 1 runtime annotation. */
    public static boolean hasAnnotations(final Class classToProcess) {
        try {
            final Annotation[] annotations = ClassReflection.getAnnotations(classToProcess);
            return annotations != null && annotations.length > 0;
        } catch (final Exception exception) {
            Exceptions.ignore(exception); // Somewhat expected on GWT.
            return false;
        }
    }

    /** @param classInAnnotation will be validated.
     * @return true if the class is not null and does not equal {@link Void} or {@code void} class. Void class is often
     *         used in annotations as default return value for optional class-returning methods. */
    public static boolean isNotVoid(final Class classInAnnotation) {
        // Null should never be returned in regular Java, but who knows what can happen on GWT.
        return classInAnnotation != null && !classInAnnotation.equals(void.class)
                && !classInAnnotation.equals(Void.class);
    }

    /** @param classInAnnotation will be validated.
     * @return true if the class is null or equals {@link Void} or {@code void} class. Void class is often used in
     *         annotations as default return value for optional class-returning methods. */
    public static boolean isVoid(final Class classInAnnotation) {
        // Null should never be returned in regular Java, but who knows what can happen on GWT.
        return classInAnnotation == null || classInAnnotation.equals(void.class)
                || classInAnnotation.equals(Void.class);
    }
}