Module Buildr::Packaging::Java
In: lib/buildr/java/packaging.rb  (CVS)

Adds packaging for Java projects: JAR, WAR, AAR, EAR, Javadoc.

Methods

Included Modules

Extension

Classes and Modules

Class Buildr::Packaging::Java::AarTask
Class Buildr::Packaging::Java::EarTask
Class Buildr::Packaging::Java::JarTask
Class Buildr::Packaging::Java::Manifest
Class Buildr::Packaging::Java::WarTask

Attributes

manifest  [RW]  Manifest used for packaging. Inherited from parent project. The default value is a hash that includes the Build-By, Build-Jdk, Implementation-Title and Implementation-Version values. The later are taken from the project‘s comment (or name) and version number.
meta_inf  [RW]  Files to always include in the package META-INF directory. The default value include the LICENSE file if one exists in the project‘s base directory.

Public Instance methods

Call this when you want the project (and all its sub-projects) to create a JavaDoc distribution. You can use the JavaDoc distribution in an IDE when coding against the API.

A JavaDoc distribution is a ZIP package with the classifier ‘javadoc’, which includes all the sources used by the compile task.

Packages use the project‘s manifest and meta_inf properties, which you can override by passing different values (e.g. false to exclude the manifest) in the options.

To create JavaDoc distributions only for specific projects, use the :only and :except options, for example:

  package_with_javadoc :only=>['foo:bar', 'foo:baz']

(Same as calling package :javadoc on each project/sub-project that has source directories.)

Call this when you want the project (and all its sub-projects) to create a source distribution. You can use the source distribution in an IDE when debugging.

A source distribution is a jar package with the classifier ‘sources’, which includes all the sources used by the compile task.

Packages use the project‘s manifest and meta_inf properties, which you can override by passing different values (e.g. false to exclude the manifest) in the options.

To create source distributions only for specific projects, use the :only and :except options, for example:

  package_with_sources :only=>['foo:bar', 'foo:baz']

(Same as calling package :sources on each project/sub-project that has source directories.)

[Validate]