org.apache.maven.archiver

Class MavenArchiveConfiguration

java.lang.Object

org.apache.maven.archiver.MavenArchiveConfiguration

public class MavenArchiveConfiguration
extends java.lang.Object

Capture common archive configuration.

Version:

$Id: MavenArchiveConfiguration.java 1738422 2016-04-10 11:51:15Z khmarbaise $

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	addMavenDescriptor
private boolean	compress
private boolean	forced
private boolean	index
private ManifestConfiguration	manifest
private java.util.Map<java.lang.String,java.lang.String>	manifestEntries
private java.io.File	manifestFile
private java.util.List<ManifestSection>	manifestSections
private java.io.File	pomPropertiesFile
private boolean	recompressAddedZips

Constructor Summary

Constructors

Constructor and Description
MavenArchiveConfiguration()

Method Summary

Modifier and Type	Method and Description
void	addManifestEntries(java.util.Map<java.lang.String,java.lang.String> map)
void	addManifestEntry(java.lang.String key, java.lang.String value)
void	addManifestSection(ManifestSection section)
void	addManifestSections(java.util.List<ManifestSection> list)
ManifestConfiguration	getManifest()
java.util.Map<java.lang.String,java.lang.String>	getManifestEntries()
java.io.File	getManifestFile()
java.util.List<ManifestSection>	getManifestSections()
java.io.File	getPomPropertiesFile() Returns the location of the "pom.properties" file.
boolean	isAddMavenDescriptor()
boolean	isCompress()
boolean	isForced() Returns, whether recreating the archive is forced (default).
boolean	isIndex()
boolean	isManifestEntriesEmpty()
boolean	isManifestSectionsEmpty()
boolean	isRecompressAddedZips()
void	setAddMavenDescriptor(boolean addMavenDescriptor)
void	setCompress(boolean compress)
void	setForced(boolean forced) Sets, whether recreating the archive is forced (default).
void	setIndex(boolean index)
void	setManifest(ManifestConfiguration manifest)
void	setManifestEntries(java.util.Map<java.lang.String,java.lang.String> manifestEntries)
void	setManifestFile(java.io.File manifestFile)
void	setManifestSections(java.util.List<ManifestSection> manifestSections)
void	setPomPropertiesFile(java.io.File pomPropertiesFile) Sets the location of the "pom.properties" file.
void	setRecompressAddedZips(boolean recompressAddedZips)

Methods inherited from class java.lang.Object

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

Field Detail

compress

private boolean compress

recompressAddedZips

private boolean recompressAddedZips

index

private boolean index

addMavenDescriptor

private boolean addMavenDescriptor

manifestFile

private java.io.File manifestFile

manifest

private ManifestConfiguration manifest

manifestEntries

private java.util.Map<java.lang.String,java.lang.String> manifestEntries

manifestSections

private java.util.List<ManifestSection> manifestSections

forced

private boolean forced

Since:

2.2

pomPropertiesFile

private java.io.File pomPropertiesFile

Since:

2.3

Constructor Detail

MavenArchiveConfiguration

public MavenArchiveConfiguration()

Method Detail

isCompress

public boolean isCompress()

Returns:

compress

isRecompressAddedZips

public boolean isRecompressAddedZips()

Returns:

recompressAddedZips

setRecompressAddedZips

public void setRecompressAddedZips(boolean recompressAddedZips)

Parameters:

recompressAddedZips - recompressAddedZips

isIndex

public boolean isIndex()

Returns:

index

isAddMavenDescriptor

public boolean isAddMavenDescriptor()

Returns:

addMavenDescriptor

getManifestFile

public java.io.File getManifestFile()

Returns:

manifestFile

getManifest

public ManifestConfiguration getManifest()

Returns:

manifest

setCompress

public void setCompress(boolean compress)

Parameters:

compress - set compress to true/false.

setIndex

public void setIndex(boolean index)

Parameters:

index - set index to true/false.

setAddMavenDescriptor

public void setAddMavenDescriptor(boolean addMavenDescriptor)

Parameters:

addMavenDescriptor - activate to add maven descriptor or not.

setManifestFile

public void setManifestFile(java.io.File manifestFile)

Parameters:

manifestFile - The manifest file.

setManifest

public void setManifest(ManifestConfiguration manifest)

Parameters:

manifest - ManifestConfiguration

addManifestEntry

public void addManifestEntry(java.lang.String key,
                             java.lang.String value)

Parameters:

key - The key of the entry.

value - The value of the entry.

addManifestEntries

public void addManifestEntries(java.util.Map<java.lang.String,java.lang.String> map)

Parameters:

map - The whole map which should be added.

isManifestEntriesEmpty

public boolean isManifestEntriesEmpty()

Returns:

are there entries true yes false otherwise.

getManifestEntries

public java.util.Map<java.lang.String,java.lang.String> getManifestEntries()

Returns:

manifestEntries

setManifestEntries

public void setManifestEntries(java.util.Map<java.lang.String,java.lang.String> manifestEntries)

Parameters:

manifestEntries - manifestEntries

addManifestSection

public void addManifestSection(ManifestSection section)

Parameters:

section - ManifestSection

addManifestSections

public void addManifestSections(java.util.List<ManifestSection> list)

Parameters:

list - Added list of ManifestSection.

isManifestSectionsEmpty

public boolean isManifestSectionsEmpty()

Returns:

if manifestSections is empty or not.

getManifestSections

public java.util.List<ManifestSection> getManifestSections()

Returns:

manifestSections

setManifestSections

public void setManifestSections(java.util.List<ManifestSection> manifestSections)

Parameters:

manifestSections - set The list of ManifestSection.

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:

setForced(boolean)

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()

getPomPropertiesFile

public java.io.File getPomPropertiesFile()

Returns the location of the "pom.properties" file. May be null, in which case a default value is choosen.

Returns:

"pom.properties" location or null.

setPomPropertiesFile

public void setPomPropertiesFile(java.io.File pomPropertiesFile)

Sets the location of the "pom.properties" file. May be null, in which case a default value is choosen.

Parameters:

pomPropertiesFile - "pom.properties" location or null.