com.exadel.aem.toolkit.plugin.metadata.scripting.Annotated Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of etoolbox-authoring-kit-plugin Show documentation

Maven plugin for storing AEM (Granite UI) markup created with Exadel Toolbox Authoring Kit

There is a newer version: 2.5.3

Show newest version

/*
 * 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.
 */
package com.exadel.aem.toolkit.plugin.metadata.scripting;

import java.lang.annotation.Annotation;
import java.lang.reflect.AnnotatedElement;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;

import org.apache.commons.lang3.StringUtils;
import org.mozilla.javascript.Callable;

import com.exadel.aem.toolkit.core.CoreConstants;

/**
 * Represents a mix-in used with {@link AbstractAdapter}-based objects to expose results or reflective operations with
 * annotations
 * @see ScriptingHelper
 */
interface Annotated {

    String METHOD_ANNOTATION = "annotation";
    String METHOD_ANNOTATIONS = "annotations";

    /**
     * Gets the {@link AnnotatedElement} instance associated with the current object
     * @return {@code AnnotatedElement} object
     */
    AnnotatedElement getAnnotatedElement();

    /**
     * Gets the {@link Annotation} instance of the type specified by method argument
     * @param args The method arguments per the contract of {@code Rhino} engine's {@link Callable}
     * @return {@code Annotation} object, or {@code null} if matching annotation is not found
     */
    default Object getAnnotation(Object[] args) {
        if (args == null || args.length < 1) {
            return null;
        }
        String name = StringUtils.stripStart(String.valueOf(args[0]), CoreConstants.SEPARATOR_AT);
        Annotation annotation = Arrays.stream(getAnnotatedElement().getDeclaredAnnotations())
            .filter(a -> name.contains(CoreConstants.SEPARATOR_DOT)
                ? a.annotationType().getName().equals(name)
                : a.annotationType().getSimpleName().equals(name))
            .findFirst()
            .orElse(null);
        if (annotation == null) {
            return null;
        }
        return new AnnotationAdapter(annotation);
    }

    /**
     * Gets a list of {@link Annotation} instances of the type specified by method argument
     * @param args The method arguments per the contract of {@code Rhino} engine's {@link Callable}
     * @return List of annotations wrapped in {@link ListAdapter}, or else null if matching annotations are not found
     */
    default Object getAnnotations(Object[] args) {
        if (args == null || args.length < 1) {
            return null;
        }
        String name = StringUtils.stripStart(String.valueOf(args[0]), CoreConstants.SEPARATOR_AT);
        List annotationAdapters = Arrays.stream(getAnnotatedElement().getDeclaredAnnotations())
            .filter(a -> name.contains(CoreConstants.SEPARATOR_DOT)
                ? a.annotationType().getName().equals(name)
                : a.annotationType().getSimpleName().equals(name))
            .map(AnnotationAdapter::new)
            .collect(Collectors.toList());
        return new ListAdapter<>(annotationAdapters);
    }
}