com.citytechinc.cq.component.content.util

Class ContentUtil

java.lang.Object

com.citytechinc.cq.component.content.util.ContentUtil

public class ContentUtil
extends Object

Method Summary

Modifier and Type	Method and Description
static List<Content>	buildContentFromClassList(List<javassist.CtClass> classList, org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream zipOutputStream, Set<String> reservedNames, File buildDirectory, String componentPathBase, String defaultComponentPathSuffix, String defaultComponentGroup, ComponentNameTransformer transformer) Constructs a list of Content objects representing .content.xml files from a list of Classes.
static void	writeContentToArchiveFile(ComponentNameTransformer transformer, File contentFile, javassist.CtClass componentClass, org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream archiveStream, Set<String> reservedNames, String componentPathBase, String defaultComponentPathSuffix) Writes a provided content file to a provided archive output stream at a path determined by the class of the component.
static File	writeContentToFile(ComponentNameTransformer transformer, Content content, javassist.CtClass componentClass, File buildDirectory, String componentPathBase, String defaultComponentPathSuffix) Write the content.xml to an output file, the path of which is determined by the component class

Methods inherited from class java.lang.Object

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

Method Detail

writeContentToFile

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

Write the content.xml to an output file, the path of which is determined by the component class

Parameters:

content -

componentClass -

Returns:

The written file

Throws:

TransformerException

ParserConfigurationException

IOException

OutputFailureException

ClassNotFoundException

NoSuchMethodException

InvocationTargetException

IllegalAccessException

SecurityException

IllegalArgumentException

writeContentToArchiveFile

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

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

Parameters:

contentFile -

componentClass -

archiveStream -

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

componentPathBase -

Throws:

IOException

ClassNotFoundException

buildContentFromClassList

public static List<Content> buildContentFromClassList(List<javassist.CtClass> classList,
                                                      org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream zipOutputStream,
                                                      Set<String> reservedNames,
                                                      File buildDirectory,
                                                      String componentPathBase,
                                                      String defaultComponentPathSuffix,
                                                      String defaultComponentGroup,
                                                      ComponentNameTransformer transformer)
                                               throws InvalidComponentClassException,
                                                      TransformerException,
                                                      ParserConfigurationException,
                                                      IOException,
                                                      OutputFailureException,
                                                      ClassNotFoundException,
                                                      IllegalArgumentException,
                                                      SecurityException,
                                                      IllegalAccessException,
                                                      InvocationTargetException,
                                                      NoSuchMethodException

Constructs a list of Content objects representing .content.xml files from a list of Classes. For each Class annotated with a Component annotation a Content object is constructed.

Parameters:

classList -

zipOutputStream -

reservedNames -

Returns:

The constructed Content objects

Throws:

InvalidComponentClassException

TransformerException

ParserConfigurationException

IOException

OutputFailureException

ClassNotFoundException

NoSuchMethodException

InvocationTargetException

IllegalAccessException

SecurityException

IllegalArgumentException