Class MavenArchiveConfiguration

java.lang.Object
org.apache.maven.shared.archiver.MavenArchiveConfiguration
public class MavenArchiveConfiguration extends Object
Capture common archive configuration.
Author:
Brett Porter

  • Constructor Details

    • MavenArchiveConfiguration

      public MavenArchiveConfiguration()

  • Method Details

    • 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

    • isAddMavenDescriptor

      public boolean isAddMavenDescriptor()

      isAddMavenDescriptor.

      Returns:
      addMavenDescriptor

    • getManifestFile

      public Path 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

    • setAddMavenDescriptor

      public void setAddMavenDescriptor(boolean addMavenDescriptor)

      Setter for the field addMavenDescriptor.

      Parameters:
      addMavenDescriptor - activate to add maven descriptor or not

    • setManifestFile

      public void setManifestFile(Path 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)
      Adds a single manifest entry.

      A null value is accepted and produces an empty-string attribute in the manifest. This is intentional: it allows callers to explicitly request an empty manifest entry. Be careful not to pass null unintentionally (e.g., from an unguarded map lookup), as the resulting empty attribute will not indicate any error.

      Parameters:
      key - the manifest attribute name
      value - the manifest attribute value; null is treated as an empty string

    • addManifestEntries

      public void addManifestEntries(Map<String,String> map)
      Adds all entries from the given map as manifest attributes.

      A null value in the map is accepted and produces an empty-string attribute in the manifest. This is intentional: it allows callers to explicitly request an empty manifest entry. Be careful not to pass null values unintentionally, as they will not indicate any error.

      Parameters:
      map - the manifest entries to add. Map values may be null, which are treated as empty strings

    • isManifestEntriesEmpty

      public boolean isManifestEntriesEmpty()

      isManifestEntriesEmpty.

      Returns:
      are there entries true yes false otherwise

    • getManifestEntries

      public Map<String,String> getManifestEntries()
      Returns the manifest entries map.

      Values in the returned map may be null. Such entries are treated as empty strings when written to the manifest.

      Returns:
      manifestEntries

    • setManifestEntries

      public void setManifestEntries(Map<String,String> manifestEntries)
      Sets the manifest entries map, replacing any previously configured entries.

      The map may contain null values. A null value is treated as an empty string when the manifest is written, producing an empty attribute for that key. This is intentional behaviour — but be careful not to pass null values unintentionally (e.g., from an unguarded map lookup), as they will be silently accepted and produce an empty manifest entry with no error.

      Parameters:
      manifestEntries - the manifest entries. Map values may be null

    • 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

      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:

    • getPomPropertiesFile

      public Path 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(Path 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