org.apache.maven.archiver

Class MavenArchiveConfiguration

java.lang.Object

org.apache.maven.archiver.MavenArchiveConfiguration

public class MavenArchiveConfiguration
extends Object

Capture common archive configuration.

Author:

Brett Porter

Constructor Summary

Constructors

Constructor and Description
MavenArchiveConfiguration()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

MavenArchiveConfiguration

public MavenArchiveConfiguration()

Method Detail

isCompress

public boolean isCompress()

isCompress.

Returns:

compress

isRecompressAddedZips

public boolean isRecompressAddedZips()

isRecompressAddedZips.

Returns:

recompressAddedZips

setRecompressAddedZips

public void setRecompressAddedZips(boolean recompressAddedZips)

Setter for the field recompressAddedZips.

Parameters:

recompressAddedZips - recompressAddedZips

isIndex

@Deprecated
public boolean isIndex()

Deprecated. See JDK-8305597

isIndex.

Returns:

index

isAddMavenDescriptor

public boolean isAddMavenDescriptor()

isAddMavenDescriptor.

Returns:

addMavenDescriptor

getManifestFile

public File getManifestFile()

Getter for the field manifestFile.

Returns:

manifestFile

getManifest

public ManifestConfiguration getManifest()

Getter for the field manifest.

Returns:

manifest

setCompress

public void setCompress(boolean compress)

Setter for the field compress.

Parameters:

compress - set compress to true/false.

setIndex

@Deprecated
public void setIndex(boolean index)

Deprecated. See JDK-8305597

Setter for the field index.

Parameters:

index - set index to true/false.

setAddMavenDescriptor

public void setAddMavenDescriptor(boolean addMavenDescriptor)

Setter for the field addMavenDescriptor.

Parameters:

addMavenDescriptor - activate to add maven descriptor or not.

setManifestFile

public void setManifestFile(File manifestFile)

Setter for the field manifestFile.

Parameters:

manifestFile - The manifest file.

setManifest

public void setManifest(ManifestConfiguration manifest)

Setter for the field manifest.

Parameters:

manifest - ManifestConfiguration

addManifestEntry

public void addManifestEntry(String key,
                             String value)

addManifestEntry.

Parameters:

key - The key of the entry.

value - The value of the entry.

addManifestEntries

public void addManifestEntries(Map<String,String> map)

addManifestEntries.

Parameters:

map - The whole map which should be added.

isManifestEntriesEmpty

public boolean isManifestEntriesEmpty()

isManifestEntriesEmpty.

Returns:

are there entries true yes false otherwise.

getManifestEntries

public Map<String,String> getManifestEntries()

Getter for the field manifestEntries.

Returns:

manifestEntries

setManifestEntries

public void setManifestEntries(Map<String,String> manifestEntries)

Setter for the field manifestEntries.

Parameters:

manifestEntries - manifestEntries

addManifestSection

public void addManifestSection(ManifestSection section)

addManifestSection.

Parameters:

section - ManifestSection

addManifestSections

public void addManifestSections(List<ManifestSection> list)

addManifestSections.

Parameters:

list - Added list of ManifestSection.

isManifestSectionsEmpty

public boolean isManifestSectionsEmpty()

isManifestSectionsEmpty.

Returns:

if manifestSections is empty or not.

getManifestSections

public List<ManifestSection> getManifestSections()

Getter for the field manifestSections.

Returns:

manifestSections

setManifestSections

public void setManifestSections(List<ManifestSection> manifestSections)

Setter for the field 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 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(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.