com.exadel.aem.toolkit.plugin.handlers.common.PropertyMappingHandler 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.handlers.common;

import java.lang.annotation.Annotation;
import java.util.Arrays;
import java.util.List;
import java.util.function.BiConsumer;

import com.exadel.aem.toolkit.api.annotations.main.AemComponent;
import com.exadel.aem.toolkit.api.annotations.main.Dialog;
import com.exadel.aem.toolkit.api.annotations.meta.AnnotationRendering;
import com.exadel.aem.toolkit.api.annotations.meta.PropertyMapping;
import com.exadel.aem.toolkit.api.handlers.Source;
import com.exadel.aem.toolkit.api.handlers.Target;
import com.exadel.aem.toolkit.plugin.metadata.Metadata;
import com.exadel.aem.toolkit.plugin.metadata.RenderingFilter;
import com.exadel.aem.toolkit.plugin.utils.ScopeUtil;

/**
 * Implements {@code BiConsumer} to populate a {@link Target} instance with properties set to be automatically mapped
 * for the use of meta-annotation such as {@link AnnotationRendering}
 */
public class PropertyMappingHandler implements BiConsumer {

    /**
     * Enumerates built-in annotations that are out of the common property mapping flow
     */
    private static final List> SPECIALLY_PROCESSED = Arrays.asList(
        AemComponent.class,
        Dialog.class
    );

    /**
     * Processes data that can be extracted from the given {@code Source} and stores it into the provided {@code Target}
     * @param source {@code Source} object used for data retrieval
     * @param target Resulting {@code Target} object
     */
    @Override
    @SuppressWarnings("deprecation") // PropertyMapping usage to be removed in a version after 2.0.2
    public void accept(Source source, Target target) {
        Annotation[] annotations = source.adaptTo(Annotation[].class);
        Arrays.stream(annotations)
            .map(Metadata::from)
            // to make sure the annotation has one of "mapping" meta-annotations
            .filter(metadata -> metadata.getAnyAnnotation(AnnotationRendering.class, PropertyMapping.class) != null)
            // to sort out annotations with specific mapping processing
            .filter(metadata -> !SPECIALLY_PROCESSED.contains(metadata.annotationType()))
            // for the exact case when @AnnotationRendering is present -- to make sure the scope is right
            .filter(metadata -> {
                AnnotationRendering annotationRendering = metadata.getAnnotation(AnnotationRendering.class);
                return annotationRendering == null || ScopeUtil.fits(target.getScope(), metadata, annotations);
            })
            .forEach(annotation -> target.attributes(annotation, new RenderingFilter(annotation)));
    }
}