com.citytechinc.cq.component.dialog.util

Class DialogUtil

java.lang.Object

com.citytechinc.cq.component.dialog.util.DialogUtil

public class DialogUtil
extends Object

Method Summary

Modifier and Type	Method and Description
static List<Dialog>	buildDialogsFromClassList(ComponentNameTransformer transformer, List<javassist.CtClass> classList, org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream zipOutputStream, Set<String> reservedNames, WidgetRegistry widgetRegistry, ClassLoader classLoader, javassist.ClassPool classPool, File buildDirectory, String componentPathBase, String defaultComponentPathSuffix) Constructs a list of Dialog objects based on Classes annotated by Component annotations.
static DialogFieldConfig	getDialogFieldFromSuperClasses(javassist.CtMethod method)
static void	writeDialogToArchiveFile(ComponentNameTransformer transformer, File dialogFile, javassist.CtClass componentClass, org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream archiveStream, Set<String> reservedNames, String componentPathBase, String defaultComponentPathSuffix) Writes a provided dialog file to a provided archive output stream at a path determined by the class of the component.
static File	writeDialogToFile(ComponentNameTransformer transformer, Dialog dialog, javassist.CtClass componentClass, File buildDirectory, String componentPathBase, String defaultComponentPathSuffix) Writes a dialog.xml file, the path of which being based on the component Class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

writeDialogToFile

public static File writeDialogToFile(ComponentNameTransformer transformer,
                                     Dialog dialog,
                                     javassist.CtClass componentClass,
                                     File buildDirectory,
                                     String componentPathBase,
                                     String defaultComponentPathSuffix)
                              throws OutputFailureException,
                                     IOException,
                                     ParserConfigurationException,
                                     TransformerException,
                                     ClassNotFoundException,
                                     IllegalArgumentException,
                                     SecurityException,
                                     IllegalAccessException,
                                     InvocationTargetException,
                                     NoSuchMethodException

Writes a dialog.xml file, the path of which being based on the component Class.

Parameters:

dialog -

componentClass -

Returns:

The written file

Throws:

OutputFailureException

IOException

ParserConfigurationException

TransformerException

ClassNotFoundException

IllegalArgumentException

SecurityException

IllegalAccessException

InvocationTargetException

NoSuchMethodException

writeDialogToArchiveFile

public static void writeDialogToArchiveFile(ComponentNameTransformer transformer,
                                            File dialogFile,
                                            javassist.CtClass componentClass,
                                            org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream archiveStream,
                                            Set<String> reservedNames,
                                            String componentPathBase,
                                            String defaultComponentPathSuffix)
                                     throws IOException,
                                            ClassNotFoundException

Writes a provided dialog file to a provided archive output stream at a path determined by the class of the component.

Parameters:

dialogFile -

componentClass -

archiveStream -

reservedNames - A list of files which already exist within the Zip Archive. If a dialog.xml file already exists for a particular component, it is left untouched.

componentPathBase -

Throws:

IOException

ClassNotFoundException

buildDialogsFromClassList

public static List<Dialog> buildDialogsFromClassList(ComponentNameTransformer transformer,
                                                     List<javassist.CtClass> classList,
                                                     org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream zipOutputStream,
                                                     Set<String> reservedNames,
                                                     WidgetRegistry widgetRegistry,
                                                     ClassLoader classLoader,
                                                     javassist.ClassPool classPool,
                                                     File buildDirectory,
                                                     String componentPathBase,
                                                     String defaultComponentPathSuffix)
                                              throws InvalidComponentClassException,
                                                     InvalidComponentFieldException,
                                                     OutputFailureException,
                                                     IOException,
                                                     ParserConfigurationException,
                                                     TransformerException,
                                                     ClassNotFoundException,
                                                     javassist.CannotCompileException,
                                                     javassist.NotFoundException,
                                                     SecurityException,
                                                     NoSuchFieldException,
                                                     IllegalArgumentException,
                                                     IllegalAccessException,
                                                     InvocationTargetException,
                                                     NoSuchMethodException,
                                                     InstantiationException

Constructs a list of Dialog objects based on Classes annotated by Component annotations. Scans the provided list of classes constructing a Dialog object for each one annotated with the Component annotation. Any classes provided in the class list which are not thusly annotated are ignored.

Parameters:

classList -

zipOutputStream -

reservedNames -

classLoader -

classPool -

Returns:

A list of constructed Dialog objects

Throws:

InvalidComponentClassException

InvalidComponentFieldException

OutputFailureException

IOException

ParserConfigurationException

TransformerException

ClassNotFoundException

javassist.CannotCompileException

javassist.NotFoundException

SecurityException

NoSuchFieldException

IllegalArgumentException

IllegalAccessException

InvocationTargetException

NoSuchMethodException

InstantiationException

getDialogFieldFromSuperClasses

public static DialogFieldConfig getDialogFieldFromSuperClasses(javassist.CtMethod method)
                                                        throws javassist.NotFoundException,
                                                               ClassNotFoundException,
                                                               InvalidComponentClassException

Throws:

javassist.NotFoundException

ClassNotFoundException

InvalidComponentClassException