com.exadel.aem.toolkit.plugin.sources.Sources 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.sources;

import java.lang.annotation.Annotation;
import java.lang.reflect.Member;

import com.exadel.aem.toolkit.api.handlers.MemberSource;
import com.exadel.aem.toolkit.api.handlers.Source;

/**
 * Contains factory methods for creating {@link Source} instances
 */
public class Sources {

    /**
     * Default (instantiation-restricting) constructor
     */
    private Sources() {
    }

    /**
     * Creates a {@link Source} facade for a Java class member
     * @param value A {@code Method} or a {@code Field} for which a source facade is created
     * @return {@code Source} instance
     */
    public static Source fromMember(Member value) {
        return fromMember(value, null);
    }

    /**
     * Creates a {@link Source} facade for a Java class member
     * @param value          {@code Method} or a {@code Field} for which a source facade is created
     * @param reportingClass {@code Class} pointer determining the class that "reports" to the ToolKit Maven plugin
     *                       about the current member (can be a class where this member was declared or a descendant of
     *                       some superclass that uses the member for UI rendering)
     * @return {@code Source} instance
     */
    public static Source fromMember(Member value, Class reportingClass) {
        return fromMember(value, reportingClass, null);
    }

    /**
     * Creates a {@link Source} facade for a Java class member
     * @param value          {@code Method} or a {@code Field} for which a source facade is created
     * @param reportingClass Optional {@code Class} pointer determining the class that "reports" to the ToolKit Maven
     *                       plugin about the current member. See {@link MemberSource#getReportingClass()}
     * @param upstreamMember Optional {@code Member} reference that triggered rendering of the class that contains the
     *                       current member. See {@link ModifiableMemberSource#getUpstreamMember()} ()}
     * @return {@code Source} instance
     */
    public static Source fromMember(Member value, Class reportingClass, Member upstreamMember) {
        ModifiableMemberSource result = new MemberSourceImpl(value);
        result.setReportingClass(reportingClass);
        result.setUpstreamMember(upstreamMember);
        return result;
    }

    /**
     * Creates a {@link Source} facade for a Java class that represents an AEM component
     * @param value {@code Class} object for which a source facade is created
     * @return {@code ComponentSource} instance
     */
    public static ComponentSource fromComponentClass(Class value) {
        return new ComponentSourceImpl(value);
    }

    /**
     * Creates a {@link Source} facade for an arbitrary Java class
     * @param value {@code Class} object for which a source facade is created
     * @return {@code Source} instance
     */
    public static Source fromClass(Class value) {
        return new ClassSourceImpl(value);
    }

    /**
     * Creates a {@link Source} facade for a Java annotation
     * @param value {@code Annotation} object for which a source facade is created
     * @return {@code Source} instance
     */
    public static Source fromAnnotation(Annotation value) {
        return new AnnotationSourceImpl(value);
    }
}