com.citytechinc.cq.component.editconfig.util

Class EditConfigUtil

java.lang.Object

com.citytechinc.cq.component.editconfig.util.EditConfigUtil

public class EditConfigUtil
extends Object

Method Summary

Modifier and Type	Method and Description
static List<EditConfig>	buildEditConfigFromClassList(List<javassist.CtClass> classList, org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream zipOutputStream, Set<String> reservedNames, InPlaceEditorRegistry inPlaceEditorRegistry, ClassLoader classLoader, javassist.ClassPool classPool, File buildDirectory, String componentPathBase, String defaultComponentPathSuffix, ComponentNameTransformer transformer) For each class in the provided classList which is annotated with a Component annotation, an EditConfig object is built and added to the returned list.
static InPlaceEditorConfig	getInPlaceEditorFromSuperClasses(javassist.CtMethod method, Set<Class<?>> registeredAnnotations)
static void	writeEditConfigToArchiveFile(ComponentNameTransformer transformer, File editConfigFile, javassist.CtClass componentClass, org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream archiveStream, Set<String> reservedNames, String componentPathBase, String defaultComponentPathSuffix) Writes a provided file to a provided archive output stream at a path determined by the class of the component.
static File	writeEditConfigToFile(ComponentNameTransformer transformer, EditConfig editConfig, javassist.CtClass componentClass, File buildDirectory, String componentPathBase, String defaultComponentPathSuffix) Determines the name of the edit config file to be written and writes the the edit config xml which the provided EditConfig object represents to that determined file.

Methods inherited from class java.lang.Object

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

Method Detail

writeEditConfigToArchiveFile

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

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

Parameters:

editConfigFile -

componentClass -

archiveStream -

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

componentPathBase -

Throws:

IOException

ClassNotFoundException

writeEditConfigToFile

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

Determines the name of the edit config file to be written and writes the the edit config xml which the provided EditConfig object represents to that determined file.

Parameters:

editConfig -

componentClass -

Returns:

The file written

Throws:

TransformerException

ParserConfigurationException

IOException

OutputFailureException

ClassNotFoundException

NoSuchMethodException

InvocationTargetException

IllegalAccessException

SecurityException

IllegalArgumentException

buildEditConfigFromClassList

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

For each class in the provided classList which is annotated with a Component annotation, an EditConfig object is built and added to the returned list. Classes which are not thusly annotated are ignored.

Parameters:

classList -

zipOutputStream -

reservedNames -

Returns:

The constructed list of EditConfig objects

Throws:

InvalidComponentClassException

TransformerException

ParserConfigurationException

IOException

OutputFailureException

ClassNotFoundException

NoSuchMethodException

InvocationTargetException

IllegalAccessException

SecurityException

IllegalArgumentException

javassist.NotFoundException

InstantiationException

getInPlaceEditorFromSuperClasses

public static InPlaceEditorConfig getInPlaceEditorFromSuperClasses(javassist.CtMethod method,
                                                                   Set<Class<?>> registeredAnnotations)
                                                            throws javassist.NotFoundException,
                                                                   ClassNotFoundException,
                                                                   InvalidComponentClassException

Throws:

javassist.NotFoundException

ClassNotFoundException

InvalidComponentClassException