com.exadel.aem.toolkit.plugin.writers.CqEditConfigWriter Maven / Gradle / Ivy

Go to download
/*
 * 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.writers;

import java.util.Arrays;
import javax.xml.transform.Transformer;

import com.exadel.aem.toolkit.api.annotations.editconfig.EditConfig;
import com.exadel.aem.toolkit.api.annotations.meta.Scopes;
import com.exadel.aem.toolkit.api.annotations.policies.AllowedChildren;
import com.exadel.aem.toolkit.api.annotations.policies.MaxChildren;
import com.exadel.aem.toolkit.api.annotations.policies.PolicyTarget;
import com.exadel.aem.toolkit.api.handlers.Source;

/**
 * The {@link PackageEntryWriter} implementation for storing subsidiary authoring process parameters for an AEM component,
 * such as dropdown behavior, in-place editing, etc. Writes data to the {@code _cq_editConfig.xml} file within the
 * current component folder before the package is uploaded
 */
class CqEditConfigWriter extends PackageEntryWriter {

    /**
     * Basic constructor
     * @param transformer {@code Transformer} instance used to serialize XML DOM document to an output stream
     */
    CqEditConfigWriter(Transformer transformer) {
        super(transformer);
    }

    /**
     * Gets {@code Scope} value of the current {@code PackageEntryWriter} implementation
     * @return String value representing a valid scope
     */
    @Override
    String getScope() {
        return Scopes.CQ_EDIT_CONFIG;
    }

    /**
     * Gets whether the current {@code Class} is eligible for populating a {@code _cq_editConfig.xml} structure
     * @param source The {@code Source} that refers to a class under consideration
     * @return True if the current {@code Class} is annotated with {@link EditConfig}; otherwise, false
     */
    @Override
    boolean canProcess(Source source) {
        Class componentClass = (Class) source.adaptTo(Class.class);
        return componentClass.isAnnotationPresent(EditConfig.class)
                || Arrays.stream(componentClass.getAnnotationsByType(AllowedChildren.class))
                .anyMatch(ac -> PolicyTarget.CURRENT.equals(ac.targetContainer()))
                || Arrays.stream(componentClass.getAnnotationsByType(MaxChildren.class))
                .anyMatch(ac -> PolicyTarget.CURRENT.equals(ac.targetContainer()));
    }
}