Package org.apache.jackrabbit.filevault.maven.packaging.mojo

Class AbstractSourceAndMetadataPackageMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.jackrabbit.filevault.maven.packaging.mojo.AbstractMetadataPackageMojo

org.apache.jackrabbit.filevault.maven.packaging.mojo.AbstractSourceAndMetadataPackageMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

GenerateCndMojo, VaultMojo

public abstract class AbstractSourceAndMetadataPackageMojo
extends AbstractMetadataPackageMojo

Commons ancestor for all mojos dealing with package source files and meta data files

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	addDefaultExcludes	By default certain metadata files are excluded which means they will not be copied into the package.
protected Set<String>	excludes	The file name patterns to exclude (in addition to the default ones mentioned at addDefaultExcludes.

Fields inherited from class org.apache.jackrabbit.filevault.maven.packaging.mojo.AbstractMetadataPackageMojo

classifier, outputTimestamp, project

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
AbstractSourceAndMetadataPackageMojo()

Method Summary

Modifier and Type	Method	Description
protected @Nullable File	getJcrSourceDirectory()
protected static @Nullable File	getJcrSourceDirectory(File[] jcrRootSourceDirectory, File builtContentDirectory, org.apache.maven.plugin.logging.Log log)

Methods inherited from class org.apache.jackrabbit.filevault.maven.packaging.mojo.AbstractMetadataPackageMojo

getFirstExistingDirectory, getMetaInfVaultSourceDirectory, getMetaInfVaultSourceDirectory, getProjectRelativeFilePath, getRelativePath, resolveArtifact, setPrefix

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.maven.plugin.Mojo

execute

Field Detail

excludes

@Parameter(property="vault.excludes",
           defaultValue="**/.vlt,**/.vltignore,**/.gitignore,**/.gitattributes",
           required=true)
protected Set<String> excludes

The file name patterns to exclude (in addition to the default ones mentioned at addDefaultExcludes. The format of each pattern is described in DirectoryScanner. The comparison is against the path relative to the according filter root. Since this is hardly predictable it is recommended to use only filename/directory name patterns here but not take into account file system hierarchies!

Each value is either a regex pattern if enclosed within %regex[ and ], otherwise an Ant pattern.

addDefaultExcludes

@Parameter(defaultValue="true")
protected boolean addDefaultExcludes

By default certain metadata files are excluded which means they will not be copied into the package. If you need them for a particular reason you can do that by setting this parameter to false. This means all files matching the following Ant patterns won't be copied by default.

• Misc: **/*~, **/#*#, **/.#*, **/%*%, **/._*
• CVS: **/CVS, **/CVS/**, **/.cvsignore
• SVN: **/.svn, **/.svn/**
• GNU: **/.arch-ids, **/.arch-ids/**
• Bazaar: **/.bzr, **/.bzr/**
• SurroundSCM: **/.MySCMServerInfo
• Mac: **/.DS_Store
• Serena Dimension: **/.metadata, **/.metadata/**
• Mercurial: **/.hg, **/.hg/**
• GIT: **/.git, **/.git/**
• Bitkeeper: **/BitKeeper, **/BitKeeper/**, **/ChangeSet, **/ChangeSet/**
• Darcs: **/_darcs, **/_darcs/**, **/.darcsrepo, **/.darcsrepo/****/-darcs-backup*, **/.darcs-temp-mail

Since:

1.1.0

See Also:

AbstractScanner.DEFAULTEXCLUDES

Constructor Detail

AbstractSourceAndMetadataPackageMojo

public AbstractSourceAndMetadataPackageMojo()

Method Detail

getJcrSourceDirectory

@Nullable
protected @Nullable File getJcrSourceDirectory()

getJcrSourceDirectory

@Nullable
protected static @Nullable File getJcrSourceDirectory(File[] jcrRootSourceDirectory,
                                                      File builtContentDirectory,
                                                      org.apache.maven.plugin.logging.Log log)