org.apache.maven.archiver

Class MavenArchiveConfiguration

public class MavenArchiveConfiguration extends Object

Capture common archive configuration.

Version: $Id: MavenArchiveConfiguration.java 433370 2006-08-21 21:46:09Z jvanzyl $

Author: Brett Porter

UNKNOWN: is this general enough to be in Plexus Archiver?

Method Summary
voidaddManifestEntries(Map map)
voidaddManifestEntry(Object key, Object value)
voidaddManifestSection(ManifestSection section)
voidaddManifestSections(List list)
ManifestConfigurationgetManifest()
MapgetManifestEntries()
FilegetManifestFile()
ListgetManifestSections()
booleanisAddMavenDescriptor()
booleanisCompress()
booleanisForced()

Returns, whether recreating the archive is forced (default).

booleanisIndex()
booleanisManifestEntriesEmpty()
booleanisManifestSectionsEmpty()
voidsetAddMavenDescriptor(boolean addMavenDescriptor)
voidsetCompress(boolean compress)
voidsetForced(boolean forced)

Sets, whether recreating the archive is forced (default).

voidsetIndex(boolean index)
voidsetManifest(ManifestConfiguration manifest)
voidsetManifestFile(File manifestFile)

Method Detail

addManifestEntries

public void addManifestEntries(Map map)

addManifestEntry

public void addManifestEntry(Object key, Object value)

addManifestSection

public void addManifestSection(ManifestSection section)

addManifestSections

public void addManifestSections(List list)

getManifest

public ManifestConfiguration getManifest()

getManifestEntries

public Map getManifestEntries()

getManifestFile

public File getManifestFile()

getManifestSections

public List getManifestSections()

isAddMavenDescriptor

public boolean isAddMavenDescriptor()

isCompress

public boolean isCompress()

isForced

public boolean isForced()

Returns, whether recreating the archive is forced (default). Setting this option to false means, that the archiver should compare the timestamps of included files with the timestamp of the target archive and rebuild the archive only, if the latter timestamp precedes the former timestamps. Checking for timestamps will typically offer a performance gain (in particular, if the following steps in a build can be suppressed, if an archive isn't recrated) on the cost that you get inaccurate results from time to time. In particular, removal of source files won't be detected.

An archiver doesn't necessarily support checks for uptodate. If so, setting this option to true will simply be ignored.

Returns: True, if the target archive should always be created; false otherwise

See Also: MavenArchiveConfiguration

isIndex

public boolean isIndex()

isManifestEntriesEmpty

public boolean isManifestEntriesEmpty()

isManifestSectionsEmpty

public boolean isManifestSectionsEmpty()

setAddMavenDescriptor

public void setAddMavenDescriptor(boolean addMavenDescriptor)

setCompress

public void setCompress(boolean compress)

setForced

public void setForced(boolean forced)

Sets, whether recreating the archive is forced (default). Setting this option to false means, that the archiver should compare the timestamps of included files with the timestamp of the target archive and rebuild the archive only, if the latter timestamp precedes the former timestamps. Checking for timestamps will typically offer a performance gain (in particular, if the following steps in a build can be suppressed, if an archive isn't recrated) on the cost that you get inaccurate results from time to time. In particular, removal of source files won't be detected.

An archiver doesn't necessarily support checks for uptodate. If so, setting this option to true will simply be ignored.

Parameters: forced True, if the target archive should always be created; false otherwise

See Also: isForced

setIndex

public void setIndex(boolean index)

setManifest

public void setManifest(ManifestConfiguration manifest)

setManifestFile

public void setManifestFile(File manifestFile)
Copyright © 2002-2009 Apache Software Foundation. All Rights Reserved.