org.gradle.api.internal.plugins.osgi

Class DefaultOsgiManifest

java.lang.Object

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

org.gradle.api.internal.plugins.osgi.DefaultOsgiManifest

All Implemented Interfaces:

Manifest, OsgiManifest

public class DefaultOsgiManifest
extends DefaultManifest
implements OsgiManifest

Author:

Hans Dockter

Constructor Summary

Constructors

Constructor and Description
DefaultOsgiManifest(FileResolver fileResolver)

Method Summary

Methods

Modifier and Type	Method and Description
Factory<ContainedVersionAnalyzer>	getAnalyzerFactory()
File	getClassesDir() Returns the classes dir.
FileCollection	getClasspath() Returns the classpath.
String	getDescription() Returns the description.
String	getDocURL() Returns the docURL value.
DefaultManifest	getEffectiveManifest() Returns a new manifest instance where all the attribute values are expanded (e.g.
Map<String,List<String>>	getInstructions() Returns all exisiting instruction.
String	getLicense() Returns the license.
String	getName() Returns the name.
String	getSymbolicName() Returns the symbolic name.
String	getVendor() Returns the vendor.
String	getVersion() Returns the version.
OsgiManifest	instruction(String name, String... values) Adds arguments to an instruction.
OsgiManifest	instructionFirst(String name, String... values) Adds arguments to an instruction.
List<String>	instructionValue(String instructionName) Returns the list of arguments for a particular instruction.
void	setAnalyzerFactory(Factory<ContainedVersionAnalyzer> analyzerFactory)
void	setClassesDir(File classesDir) Sets the classes dir.
void	setClasspath(FileCollection classpath) A convenient method for setting a Bundle-Classpath instruction.
void	setDescription(String description) A convenient method for setting a Bundle-Description instruction.
void	setDocURL(String docURL) A convenient method for setting a Bundle-DocURL instruction.
void	setInstructions(Map<String,List<String>> instructions)
void	setLicense(String license) A convenient method for setting a Bundle-License instruction.
void	setName(String name) A convenient method for setting a Bundle-Name instruction.
void	setSymbolicName(String symbolicName) A convenient method for setting a Bundle-SymbolicName instruction.
void	setVendor(String vendor) A convenient method for setting a Bundle-Vendor instruction.
void	setVersion(String version) A convenient method for setting a Bundle-Version instruction.

Methods inherited from class org.gradle.api.java.archives.internal.DefaultManifest

attributes, attributes, clear, from, from, getAttributes, getEffectiveManifestInternal, getMergeSpecs, getSections, isEqualsTo, mainAttributes, writeTo, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gradle.api.java.archives.Manifest

attributes, attributes, from, from, getAttributes, getSections, writeTo, writeTo

Constructor Detail

DefaultOsgiManifest

public DefaultOsgiManifest(FileResolver fileResolver)

Method Detail

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

Overrides:

getEffectiveManifest in class DefaultManifest

instructionValue

public List<String> instructionValue(String instructionName)

Description copied from interface: OsgiManifest

Returns the list of arguments for a particular instruction.

Specified by:

instructionValue in interface OsgiManifest

Returns:

The list of arguments

See Also:

OsgiManifest.instruction(String, String...)

instruction

public OsgiManifest instruction(String name,
                       String... values)

Description copied from interface: OsgiManifest

Adds arguments to an instruction. If the instruction does not exists, it is created. If it does exists, the arguments are appended to the existing arguments.

Specified by:

instruction in interface OsgiManifest

Returns:

this

See Also:

OsgiManifest.instructionFirst(String, String...)

instructionFirst

public OsgiManifest instructionFirst(String name,
                            String... values)

Description copied from interface: OsgiManifest

Adds arguments to an instruction. If the instruction does not exists, it is created. If it does exists, the arguments are inserted before the existing arguments.

Specified by:

instructionFirst in interface OsgiManifest

Parameters:

name - Name of the instruction.

values - The values for the instruction.

Returns:

this

See Also:

OsgiManifest.instructionFirst(String, String...)

getInstructions

public Map<String,List<String>> getInstructions()

Description copied from interface: OsgiManifest

Returns all exisiting instruction.

Specified by:

getInstructions in interface OsgiManifest

Returns:

A map with instructions. The key of the map is the instruction name, the value a list of arguments.

setInstructions

public void setInstructions(Map<String,List<String>> instructions)

getSymbolicName

public String getSymbolicName()

Description copied from interface: OsgiManifest

Returns the symbolic name.

Specified by:

getSymbolicName in interface OsgiManifest

Returns:

the symbolic name.

See Also:

OsgiManifest.setSymbolicName(String)

setSymbolicName

public void setSymbolicName(String symbolicName)

Description copied from interface: OsgiManifest

A convenient method for setting a Bundle-SymbolicName instruction.

Specified by:

setSymbolicName in interface OsgiManifest

Parameters:

symbolicName - the symbolicName to set

getName

public String getName()

Description copied from interface: OsgiManifest

Returns the name.

Specified by:

getName in interface OsgiManifest

See Also:

OsgiManifest.setName(String)

setName

public void setName(String name)

Description copied from interface: OsgiManifest

A convenient method for setting a Bundle-Name instruction.

Specified by:

setName in interface OsgiManifest

Parameters:

name - the name to set

getVersion

public String getVersion()

Description copied from interface: OsgiManifest

Returns the version.

Specified by:

getVersion in interface OsgiManifest

See Also:

OsgiManifest.setVersion(String)

setVersion

public void setVersion(String version)

Description copied from interface: OsgiManifest

A convenient method for setting a Bundle-Version instruction.

Specified by:

setVersion in interface OsgiManifest

Parameters:

version - the version to set

getDescription

public String getDescription()

Description copied from interface: OsgiManifest

Returns the description.

Specified by:

getDescription in interface OsgiManifest

See Also:

OsgiManifest.setDescription(String)

setDescription

public void setDescription(String description)

Description copied from interface: OsgiManifest

A convenient method for setting a Bundle-Description instruction.

Specified by:

setDescription in interface OsgiManifest

Parameters:

description - the description to set

getLicense

public String getLicense()

Description copied from interface: OsgiManifest

Returns the license.

Specified by:

getLicense in interface OsgiManifest

See Also:

OsgiManifest.setLicense(String)

setLicense

public void setLicense(String license)

Description copied from interface: OsgiManifest

A convenient method for setting a Bundle-License instruction.

Specified by:

setLicense in interface OsgiManifest

Parameters:

license - The license to set

getVendor

public String getVendor()

Description copied from interface: OsgiManifest

Returns the vendor.

Specified by:

getVendor in interface OsgiManifest

See Also:

OsgiManifest.setVendor(String)

setVendor

public void setVendor(String vendor)

Description copied from interface: OsgiManifest

A convenient method for setting a Bundle-Vendor instruction.

Specified by:

setVendor in interface OsgiManifest

Parameters:

vendor - The vendor to set

getDocURL

public String getDocURL()

Description copied from interface: OsgiManifest

Returns the docURL value.

Specified by:

getDocURL in interface OsgiManifest

See Also:

OsgiManifest.setDocURL(String)

setDocURL

public void setDocURL(String docURL)

Description copied from interface: OsgiManifest

A convenient method for setting a Bundle-DocURL instruction.

Specified by:

setDocURL in interface OsgiManifest

Parameters:

docURL - the docURL to set.

getClassesDir

public File getClassesDir()

Description copied from interface: OsgiManifest

Returns the classes dir.

Specified by:

getClassesDir in interface OsgiManifest

See Also:

OsgiManifest.setClassesDir(java.io.File)

setClassesDir

public void setClassesDir(File classesDir)

Description copied from interface: OsgiManifest

Sets the classes dir. This directory is the major source of input for generation the OSGi manifest. All classes are analyzed for its packages and package dependencies. Based on this the Import-Package value is set. This auto generated value can be overwritten by explicitly setting an instruction.

Specified by:

setClassesDir in interface OsgiManifest

See Also:

OsgiManifest.instruction(String, String...)

getClasspath

public FileCollection getClasspath()

Description copied from interface: OsgiManifest

Returns the classpath.

Specified by:

getClasspath in interface OsgiManifest

See Also:

OsgiManifest.setClasspath(org.gradle.api.file.FileCollection)

setClasspath

public void setClasspath(FileCollection classpath)

Description copied from interface: OsgiManifest

A convenient method for setting a Bundle-Classpath instruction. The information of the classpath elements are only used if they are OSGi bundles. In this case for example the version information provided by the bundle is used in the Import-Package of the generated OSGi bundle.

Specified by:

setClasspath in interface OsgiManifest

Parameters:

classpath - The classpath elements

getAnalyzerFactory

public Factory<ContainedVersionAnalyzer> getAnalyzerFactory()

setAnalyzerFactory

public void setAnalyzerFactory(Factory<ContainedVersionAnalyzer> analyzerFactory)