org.gradle.api.java.archives.internal

Class DefaultManifest

java.lang.Object

org.gradle.api.java.archives.internal.DefaultManifest

All Implemented Interfaces:

Manifest

Direct Known Subclasses:

DefaultOsgiManifest

public class DefaultManifest
extends Object
implements Manifest

Author:

Hans Dockter

Constructor Summary

Constructors

Constructor and Description
DefaultManifest(FileResolver fileResolver)
DefaultManifest(Object manifestPath, FileResolver fileResolver)

Method Summary

Methods

Modifier and Type	Method and Description
DefaultManifest	attributes(Map<String,?> attributes) Adds content to the main attributes of the manifest.
DefaultManifest	attributes(Map<String,?> attributes, String sectionName) Adds content to the given section of the manifest.
DefaultManifest	clear()
DefaultManifest	from(Object... mergePaths) Specifies other manifests to be merged into this manifest.
DefaultManifest	from(Object mergePaths, Closure closure) Specifies other manifests to be merged into this manifest.
Attributes	getAttributes() Returns the main attributes of the manifest.
DefaultManifest	getEffectiveManifest() Returns a new manifest instance where all the attribute values are expanded (e.g.
protected DefaultManifest	getEffectiveManifestInternal(DefaultManifest baseManifest)
List<ManifestMergeSpec>	getMergeSpecs()
Map<String,Attributes>	getSections() Returns the sections of the manifest (excluding the main section).
boolean	isEqualsTo(Object o)
DefaultManifest	mainAttributes(Map<String,?> attributes)
Manifest	writeTo(Object path) Writes the manifest into a file.
DefaultManifest	writeTo(Writer writer) Writes the manifest into a writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultManifest

public DefaultManifest(FileResolver fileResolver)

DefaultManifest

public DefaultManifest(Object manifestPath,
               FileResolver fileResolver)

Method Detail

mainAttributes

public DefaultManifest mainAttributes(Map<String,?> attributes)

attributes

public DefaultManifest attributes(Map<String,?> attributes)

Description copied from interface: Manifest

Adds content to the main attributes of the manifest.

Specified by:

attributes in interface 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 Manifest.getEffectiveManifest() is called.

Returns:

this

attributes

public DefaultManifest attributes(Map<String,?> attributes,
                         String sectionName)

Description copied from interface: Manifest

Adds content to the given section of the manifest.

Specified by:

attributes in interface 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 Manifest.getEffectiveManifest() is called.

sectionName - The name of the section

Returns:

this

getAttributes

public Attributes getAttributes()

Description copied from interface: Manifest

Returns the main attributes of the manifest.

Specified by:

getAttributes in interface Manifest

getSections

public Map<String,Attributes> getSections()

Description copied from interface: Manifest

Returns the sections of the manifest (excluding the main section).

Specified by:

getSections in interface Manifest

Returns:

A map with the sections, where the key represents the section name and value the section attributes.

clear

public DefaultManifest clear()

from

public DefaultManifest from(Object... mergePaths)

Description copied from interface: Manifest

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

Specified by:

from in interface Manifest

Returns:

this

from

public DefaultManifest from(Object mergePaths,
                   Closure closure)

Description copied from interface: Manifest

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

Specified by:

from in interface Manifest

Returns:

this

getEffectiveManifest

public DefaultManifest getEffectiveManifest()

Description copied from interface: Manifest

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

Specified by:

getEffectiveManifest in interface Manifest

getEffectiveManifestInternal

protected DefaultManifest getEffectiveManifestInternal(DefaultManifest baseManifest)

writeTo

public DefaultManifest writeTo(Writer writer)

Description copied from interface: Manifest

Writes the manifest into a writer.

Specified by:

writeTo in interface Manifest

Parameters:

writer - The writer to write the manifest to

Returns:

this

writeTo

public Manifest writeTo(Object path)

Description copied from interface: Manifest

Writes the manifest into a file. The path's are resolved as defined by Project.files(Object...)

Specified by:

writeTo in interface Manifest

Parameters:

path - The path of the file to write the manifest into.

Returns:

this

getMergeSpecs

public List<ManifestMergeSpec> getMergeSpecs()

isEqualsTo

public boolean isEqualsTo(Object o)