Class DefaultFilesetArchetypeGenerator

java.lang.Object

org.apache.maven.archetype.generator.DefaultFilesetArchetypeGenerator

All Implemented Interfaces:

FilesetArchetypeGenerator

@Named
@Singleton
public class DefaultFilesetArchetypeGenerator
extends Object
implements FilesetArchetypeGenerator

Field Summary

Fields

Modifier and Type	Field	Description
private ArchetypeArtifactManager	archetypeArtifactManager
private ArchetypeFilesResolver	archetypeFilesResolver
private static final org.slf4j.Logger	LOGGER
private PomManager	pomManager
private static final Pattern	TOKEN_PATTERN	Pattern used to detect tokens in a string.
private org.codehaus.plexus.velocity.VelocityComponent	velocity

Fields inherited from interface FilesetArchetypeGenerator

ROLE

Constructor Summary

Constructors

Constructor	Description
DefaultFilesetArchetypeGenerator(ArchetypeArtifactManager archetypeArtifactManager, ArchetypeFilesResolver archetypeFilesResolver, PomManager pomManager, org.codehaus.plexus.velocity.VelocityComponent velocity)

Method Summary

Modifier and Type	Method	Description
private boolean	copyFile(File outFile, String template, boolean failIfExists, ZipFile archetypeZipFile)
private int	copyFiles(String directory, List<String> fileSetResources, boolean packaged, String packageName, File outputDirectoryFile, ZipFile archetypeZipFile, String moduleOffset, boolean failIfExists, org.apache.velocity.context.Context context)
private String	evaluateExpression(org.apache.velocity.context.Context context, String key, String value)
void	generateArchetype(ArchetypeGenerationRequest request, File archetypeFile)	Generate a project from an archetype file.
private String	getEncoding(String archetypeEncoding)
private String	getOffsetSeparator(String moduleOffset)
private File	getOutputFile(String template, String directory, File outputDirectoryFile, boolean packaged, String packageName, String moduleOffset, org.apache.velocity.context.Context context)
String	getPackageAsDirectory(String packageName)
private String	getPackageInPathFormat(String aPackage)
private File	getTemporaryFile(File file)
private boolean	isArchetypeConfigured(ArchetypeDescriptor archetypeDescriptor, ArchetypeGenerationRequest request)
private boolean	maybeVelocityExpression(String value)
private org.apache.velocity.context.Context	prepareVelocityContext(ArchetypeGenerationRequest request)
private void	processArchetypeTemplates(AbstractArchetypeDescriptor archetypeDescriptor, List<String> archetypeResources, ZipFile archetypeZipFile, String moduleOffset, org.apache.velocity.context.Context context, String packageName, File outputDirectoryFile)
private void	processArchetypeTemplatesWithWarning(ArchetypeDescriptor archetypeDescriptor, List<String> archetypeResources, ZipFile archetypeZipFile, String moduleOffset, org.apache.velocity.context.Context context, String packageName, File outputDirectoryFile)
private int	processFileSet(String directory, List<String> fileSetResources, boolean packaged, String packageName, org.apache.velocity.context.Context context, File outputDirectoryFile, String moduleOffset, String archetypeEncoding, boolean failIfExists)
private void	processFilesetModule(String rootArtifactId, String artifactId, List<String> archetypeResources, File pom, ZipFile archetypeZipFile, String moduleOffset, File basedirPom, File outputDirectoryFile, String packageName, AbstractArchetypeDescriptor archetypeDescriptor, org.apache.velocity.context.Context context)
private void	processFilesetProject(AbstractArchetypeDescriptor archetypeDescriptor, String moduleId, List<String> archetypeResources, File pom, ZipFile archetypeZipFile, String moduleOffset, org.apache.velocity.context.Context context, String packageName, File outputDirectoryFile, File basedirPom)
private void	processPom(org.apache.velocity.context.Context context, File pom, String moduleOffset)
private void	processPomWithMerge(org.apache.velocity.context.Context context, File pom, String moduleOffset)
private void	processPomWithParent(org.apache.velocity.context.Context context, File pom, String moduleOffset, File basedirPom, String moduleId)
private boolean	processTemplate(File outFile, org.apache.velocity.context.Context context, String templateFileName, String encoding, boolean failIfExists)
private void	processTemplates(String packageName, File outputDirectoryFile, org.apache.velocity.context.Context context, AbstractArchetypeDescriptor archetypeDescriptor, List<String> archetypeResources, ZipFile archetypeZipFile, String moduleOffset, boolean failIfExists)
private String	replaceFilenameTokens(String filePath, org.apache.velocity.context.Context context)	Replaces all tokens (text matching TOKEN_PATTERN) within the given string, using properties contained within the context.
private void	restoreParentArtifactId(org.apache.velocity.context.Context context, String parentArtifactId)
private void	setParentArtifactId(org.apache.velocity.context.Context context, String artifactId)

Methods inherited from class Object

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

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

archetypeArtifactManager

private ArchetypeArtifactManager archetypeArtifactManager

archetypeFilesResolver

private ArchetypeFilesResolver archetypeFilesResolver

pomManager

private PomManager pomManager

velocity

private org.codehaus.plexus.velocity.VelocityComponent velocity

TOKEN_PATTERN

private static final Pattern TOKEN_PATTERN

Pattern used to detect tokens in a string. Tokens are any text surrounded by the delimiter __.

Constructor Details

DefaultFilesetArchetypeGenerator

@Inject
public DefaultFilesetArchetypeGenerator(ArchetypeArtifactManager archetypeArtifactManager,
 ArchetypeFilesResolver archetypeFilesResolver,
 PomManager pomManager,
 org.codehaus.plexus.velocity.VelocityComponent velocity)

Method Details

generateArchetype

public void generateArchetype(ArchetypeGenerationRequest request,
 File archetypeFile)
                       throws UnknownArchetype,
ArchetypeNotConfigured,
ProjectDirectoryExists,
PomFileExists,
OutputFileExists,
ArchetypeGenerationFailure,
InvalidPackaging

Description copied from interface: FilesetArchetypeGenerator

Generate a project from an archetype file.

Specified by:

generateArchetype in interface FilesetArchetypeGenerator

Throws:

UnknownArchetype

ArchetypeNotConfigured

ProjectDirectoryExists

PomFileExists

OutputFileExists

ArchetypeGenerationFailure

InvalidPackaging

getPackageAsDirectory

public String getPackageAsDirectory(String packageName)

copyFile

private boolean copyFile(File outFile,
 String template,
 boolean failIfExists,
 ZipFile archetypeZipFile)
                  throws OutputFileExists,
IOException

Throws:

OutputFileExists

IOException

copyFiles

private int copyFiles(String directory,
 List<String> fileSetResources,
 boolean packaged,
 String packageName,
 File outputDirectoryFile,
 ZipFile archetypeZipFile,
 String moduleOffset,
 boolean failIfExists,
 org.apache.velocity.context.Context context)
               throws OutputFileExists,
IOException

Throws:

OutputFileExists

IOException

getEncoding

private String getEncoding(String archetypeEncoding)

getOffsetSeparator

private String getOffsetSeparator(String moduleOffset)

getOutputFile

private File getOutputFile(String template,
 String directory,
 File outputDirectoryFile,
 boolean packaged,
 String packageName,
 String moduleOffset,
 org.apache.velocity.context.Context context)

replaceFilenameTokens

private String replaceFilenameTokens(String filePath,
 org.apache.velocity.context.Context context)

Replaces all tokens (text matching TOKEN_PATTERN) within the given string, using properties contained within the context. If a property does not exist in the context, the token is left unmodified and a warning is logged.

Parameters:

filePath - the file name and path to be interpolated

context - contains the available properties

getPackageInPathFormat

private String getPackageInPathFormat(String aPackage)

isArchetypeConfigured

private boolean isArchetypeConfigured(ArchetypeDescriptor archetypeDescriptor,
 ArchetypeGenerationRequest request)

setParentArtifactId

private void setParentArtifactId(org.apache.velocity.context.Context context,
 String artifactId)

prepareVelocityContext

private org.apache.velocity.context.Context prepareVelocityContext(ArchetypeGenerationRequest request)

maybeVelocityExpression

private boolean maybeVelocityExpression(String value)

evaluateExpression

private String evaluateExpression(org.apache.velocity.context.Context context,
 String key,
 String value)

processArchetypeTemplates

private void processArchetypeTemplates(AbstractArchetypeDescriptor archetypeDescriptor,
 List<String> archetypeResources,
 ZipFile archetypeZipFile,
 String moduleOffset,
 org.apache.velocity.context.Context context,
 String packageName,
 File outputDirectoryFile)
                                throws OutputFileExists,
ArchetypeGenerationFailure,
IOException

Throws:

OutputFileExists

ArchetypeGenerationFailure

IOException

processArchetypeTemplatesWithWarning

private void processArchetypeTemplatesWithWarning(ArchetypeDescriptor archetypeDescriptor,
 List<String> archetypeResources,
 ZipFile archetypeZipFile,
 String moduleOffset,
 org.apache.velocity.context.Context context,
 String packageName,
 File outputDirectoryFile)
                                           throws OutputFileExists,
ArchetypeGenerationFailure,
IOException

Throws:

OutputFileExists

ArchetypeGenerationFailure

IOException

processFileSet

private int processFileSet(String directory,
 List<String> fileSetResources,
 boolean packaged,
 String packageName,
 org.apache.velocity.context.Context context,
 File outputDirectoryFile,
 String moduleOffset,
 String archetypeEncoding,
 boolean failIfExists)
                    throws IOException,
OutputFileExists,
ArchetypeGenerationFailure

Throws:

IOException

OutputFileExists

ArchetypeGenerationFailure

processFilesetModule

private void processFilesetModule(String rootArtifactId,
 String artifactId,
 List<String> archetypeResources,
 File pom,
 ZipFile archetypeZipFile,
 String moduleOffset,
 File basedirPom,
 File outputDirectoryFile,
 String packageName,
 AbstractArchetypeDescriptor archetypeDescriptor,
 org.apache.velocity.context.Context context)
                           throws org.codehaus.plexus.util.xml.pull.XmlPullParserException,
IOException,
ParserConfigurationException,
SAXException,
TransformerException,
OutputFileExists,
ArchetypeGenerationFailure,
InvalidPackaging

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

IOException

ParserConfigurationException

SAXException

TransformerException

OutputFileExists

ArchetypeGenerationFailure

InvalidPackaging

processFilesetProject

private void processFilesetProject(AbstractArchetypeDescriptor archetypeDescriptor,
 String moduleId,
 List<String> archetypeResources,
 File pom,
 ZipFile archetypeZipFile,
 String moduleOffset,
 org.apache.velocity.context.Context context,
 String packageName,
 File outputDirectoryFile,
 File basedirPom)
                            throws org.codehaus.plexus.util.xml.pull.XmlPullParserException,
IOException,
ParserConfigurationException,
SAXException,
TransformerException,
OutputFileExists,
ArchetypeGenerationFailure,
InvalidPackaging

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

IOException

ParserConfigurationException

SAXException

TransformerException

OutputFileExists

ArchetypeGenerationFailure

InvalidPackaging

processPom

private void processPom(org.apache.velocity.context.Context context,
 File pom,
 String moduleOffset)
                 throws IOException,
OutputFileExists,
ArchetypeGenerationFailure

Throws:

IOException

OutputFileExists

ArchetypeGenerationFailure

processPomWithMerge

private void processPomWithMerge(org.apache.velocity.context.Context context,
 File pom,
 String moduleOffset)
                          throws OutputFileExists,
IOException,
org.codehaus.plexus.util.xml.pull.XmlPullParserException,
ArchetypeGenerationFailure

Throws:

OutputFileExists

IOException

org.codehaus.plexus.util.xml.pull.XmlPullParserException

ArchetypeGenerationFailure

processPomWithParent

private void processPomWithParent(org.apache.velocity.context.Context context,
 File pom,
 String moduleOffset,
 File basedirPom,
 String moduleId)
                           throws org.codehaus.plexus.util.xml.pull.XmlPullParserException,
IOException,
ParserConfigurationException,
SAXException,
TransformerException,
OutputFileExists,
ArchetypeGenerationFailure,
InvalidPackaging

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

IOException

ParserConfigurationException

SAXException

TransformerException

OutputFileExists

ArchetypeGenerationFailure

InvalidPackaging

processTemplate

private boolean processTemplate(File outFile,
 org.apache.velocity.context.Context context,
 String templateFileName,
 String encoding,
 boolean failIfExists)
                         throws IOException,
OutputFileExists,
ArchetypeGenerationFailure

Throws:

IOException

OutputFileExists

ArchetypeGenerationFailure

processTemplates

private void processTemplates(String packageName,
 File outputDirectoryFile,
 org.apache.velocity.context.Context context,
 AbstractArchetypeDescriptor archetypeDescriptor,
 List<String> archetypeResources,
 ZipFile archetypeZipFile,
 String moduleOffset,
 boolean failIfExists)
                       throws OutputFileExists,
ArchetypeGenerationFailure,
IOException

Throws:

OutputFileExists

ArchetypeGenerationFailure

IOException

restoreParentArtifactId

private void restoreParentArtifactId(org.apache.velocity.context.Context context,
 String parentArtifactId)

getTemporaryFile

private File getTemporaryFile(File file)