Manifest (Gradle API 8.14) (original) (raw)

public interface Manifest

Represents the manifest file of a JAR file.

• Method Summary

Adds content to the main attributes of the manifest.
Adds content to the given section of the manifest.
Specifies other manifests to be merged into this manifest.
Specifies other manifests to be merged into this manifest.
Specifies other manifests to be merged into this manifest.
Returns the main attributes of the manifest.
Returns a new manifest instance where all the attribute values are expanded (e.g.
Returns the sections of the manifest (excluding the main section).
Writes the manifest into a file.

• Method Details

  • getAttributes

  Returns the main attributes of the manifest.

  • getSections

  Returns the sections of the manifest (excluding the main section).
  Returns:
  A map with the sections, where the key represents the section name and value the section attributes.

  • attributes

  Adds content to the main attributes of the manifest.
  Parameters:
  attributes - The values to add to the main attributes. The values can be any object. For evaluating the value objects their Object.toString() method is used. This is done lazily either before writing or when getEffectiveManifest() is called.
  Returns:
  this
  Throws:
  [ManifestException](ManifestException.html "class in org.gradle.api.java.archives") - If a key is invalid according to the manifest spec or if a key or value is null.

  • attributes

  Adds content to the given section of the manifest.
  Parameters:
  attributes - The values to add to the section. The values can be any object. For evaluating the value objects their Object.toString() method is used. This is done lazily either before writing or when getEffectiveManifest() is called.
  sectionName - The name of the section
  Returns:
  this
  Throws:
  [ManifestException](ManifestException.html "class in org.gradle.api.java.archives") - If a key is invalid according to the manifest spec or if a key or value is null.

  • getEffectiveManifest

  Returns a new manifest instance where all the attribute values are expanded (e.g. their toString method is called). The returned manifest also contains all the attributes of the to be merged manifests specified in from(Object...).

  • writeTo

  Parameters:
  path - The path of the file to write the manifest into.
  Returns:
  this

  • from

  Specifies other manifests to be merged into this manifest. A merge path can either be another instance ofManifest or a file path as interpreted by Project.file(Object). The merge is not happening instantaneously. It happens either before writing or when getEffectiveManifest() is called.
  Returns:
  this

  • from

  Specifies other manifests to be merged into this manifest. A merge path is interpreted as described infrom(Object...). The merge is not happening instantaneously. It happens either before writing or when getEffectiveManifest() is called. The closure configures the underlying ManifestMergeSpec.
  Returns:
  this

  • from

  Specifies other manifests to be merged into this manifest. A merge path is interpreted as described infrom(Object...). The merge is not happening instantaneously. It happens either before writing or when getEffectiveManifest() is called.
  Returns:
  this
  Since:
  5.0