com.citytechinc.cq.component.dialog.maker.WidgetMaker Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cq-component-annotations Show documentation

There is a newer version: 7.0.0

Show newest version

package com.citytechinc.cq.component.dialog.maker;

import com.citytechinc.cq.component.dialog.DialogElement;
import com.citytechinc.cq.component.dialog.exception.InvalidComponentFieldException;
import javassist.CannotCompileException;
import javassist.NotFoundException;

import java.lang.reflect.InvocationTargetException;

/**
 * A WidgetMaker is a class which is intended to create a single Widget based on
 * an annotated Field in a Component Class. Such a Maker will return an object
 * implementing DialogElement suitable for addition into a Dialog.
 * 
 * Widget Makers are tied to concrete widget types by way of a
 * {@link com.citytechinc.cq.component.annotations.config.Widget} annotation.
 */
public interface WidgetMaker {

    /**
     * @return A constructed DialogElement Widget
     * @throws InvalidComponentFieldException
     * @throws NotFoundException
     * @throws ClassNotFoundException
     * @throws SecurityException
     * @throws CannotCompileException
     * @throws NoSuchFieldException
     * @throws InstantiationException
     * @throws IllegalAccessException
     * @throws IllegalArgumentException
     * @throws InvocationTargetException
     * @throws NoSuchMethodException
     */
    DialogElement make() throws InvalidComponentFieldException, NotFoundException, ClassNotFoundException,
        SecurityException, CannotCompileException, NoSuchFieldException, InstantiationException,
        IllegalAccessException, IllegalArgumentException, InvocationTargetException, NoSuchMethodException;
}