com.exadel.aem.toolkit.plugin.writers.CqDialogWriter 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.writers;

import javax.xml.transform.Transformer;

import com.exadel.aem.toolkit.api.annotations.main.DesignDialog;
import com.exadel.aem.toolkit.api.annotations.main.Dialog;
import com.exadel.aem.toolkit.api.annotations.meta.Scopes;
import com.exadel.aem.toolkit.api.handlers.Source;

/**
 * The {@link PackageEntryWriter} implementation for storing Granite UI dialog definition (writes data to the
 * {@code _cq_dialog.xml} file within the current component folder before the package is uploaded)
 */
class CqDialogWriter extends PackageEntryWriter {

    private final String scope;

    /**
     * Basic constructor
     * @param transformer {@code Transformer} instance used to serialize XML DOM document to an output stream
     * @param scope       Current scope value
     */
    CqDialogWriter(Transformer transformer, String scope) {
        super(transformer);
        this.scope = scope;
    }

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

    /**
     * Gets whether the current {@code Class} is eligible for populating a {@code _cq_dialog.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 Dialog} or {@link DesignDialog}; otherwise, false
     */
    @Override
    boolean canProcess(Source source) {
        return Scopes.CQ_DIALOG.equals(scope)
            ? source.adaptTo(Dialog.class) != null
            : source.adaptTo(DesignDialog.class) != null;
    }
}