Professional Documents
Culture Documents
Jar Task
Jar Task
html
Jar
Description
Jars a set of files.
Note that file permissions will not be stored in the resulting jarfile.
It is possible to refine the set of files that are being jarred. This can be done with the includes, includesfile, excludes, excludesfile and defaultexcludes attributes. With
the includes or includesfile attribute you specify the files you want to have included by using patterns. The exclude or excludesfile attribute is used to specify the files
you want to have excluded. This is also done with patterns. And finally with the defaultexcludes attribute, you can specify whether you want to use default
exclusions or not. See the section on directory based tasks, on how the inclusion/exclusion of files works, and how to write patterns.
This task forms an implicit FileSet and supports most attributes of <fileset> (dir becomes basedir) as well as the nested <include>, <exclude> and
<patternset> elements.
You can also use nested file sets for more flexibility, and specify multiple ones to merge together different trees of files into one JAR. The extended fileset and
groupfileset child elements from the zip task are also available in the jar task. See the Zip task for more details and examples.
The update parameter controls what happens if the JAR file already exists. When set to yes, the JAR file is updated with the files specified. When set to no (the
default) the JAR file is overwritten. An example use of this is provided in the Zip task documentation. Please note that ZIP files store file modification times with a
granularity of two seconds. If a file is less than two seconds newer than the entry in the archive, Ant will not consider it newer.
The whenmanifestonly parameter controls what happens when no files, apart from the manifest file, or nested services, match. If skip, the JAR is not created and a
warning is issued. If fail, the JAR is not created and the build is halted with an error. If create, (default) an empty JAR file (only containing a manifest and
services) is created.
(The Jar task is a shortcut for specifying the manifest file of a JAR file. The same thing can be accomplished by using the fullpath attribute of a zipfileset in a Zip
task. The one difference is that if the manifest attribute is not specified, the Jar task will include an empty one for you.)
Manifests are processed by the Jar task according to the Jar file specification. Note in particular that this may result in manifest lines greater than 72 bytes being
wrapped and continued on the next line.
21/10/2014 10:42
file:///D:/eclipse/documentation/Ant/jar.html
The Jar task checks whether you specified package information according to the versioning specification.
Please note that the zip format allows multiple files of the same fully-qualified name to exist within a single archive. This has been documented as causing
various problems for unsuspecting users. If you wish to avoid this behavior you must set the duplicate attribute to a value other than its default, "add".
Parameters
21/10/2014 10:42
file:///D:/eclipse/documentation/Ant/jar.html
index whether to create an index list to speed up classloading. This is a JDK 1.3+ specific feature. Unless you specify No
additional jars with nested indexjars elements, only the contents of this jar will be included in the index. Defaults to
false.
indexMetaInf whether to include META-INF and its children in the index. Doesn't have any effect if index is false. No
Sun's jar implementation used to skip the META-INF directory and Ant followed that example. The behavior has been
changed with Java 5. In order to avoid problems with Ant generated jars on Java 1.4 or earlier Ant will not include
META-INF unless explicitly asked to.
Ant 1.8.0 - Defaults to false.
manifestencoding The encoding used to read the JAR manifest, when a manifest file is specified. The task will always use UTF-8 when No, defaults to
writing the manifest. the platform
encoding.
roundup Whether the file modification times will be rounded up to the next even number of seconds. No
Zip archives store file modification times with a granularity of two seconds, so the times will either be rounded up or
down. If you round down, the archive will always seem out-of-date when you rerun the task, so the default is to round
up. Rounding up may lead to a different type of problems like JSPs inside a web archive that seem to be slightly more
recent than precompiled pages, rendering precompilation useless.
Defaults to true. Since Ant 1.6.2
level Non-default level at which file compression should be performed. Valid values range from 0 (no compression/fastest) No
to 9 (maximum compression/slowest). Since Ant 1.7
strict Configures how to handle breaks of the packaging version specification: No, defaults to
ignore.
fail = throws a BuildException
warn = logs a message on warn level
ignore = logs a message on verbose level (default)
21/10/2014 10:42
file:///D:/eclipse/documentation/Ant/jar.html
Nested elements
metainf
The nested metainf element specifies a FileSet. All files included in this fileset will end up in the META-INF directory of the jar file. If this fileset includes a file
named MANIFEST.MF, the file is ignored and you will get a warning.
manifest
The manifest nested element allows the manifest for the Jar file to be provided inline in the build file rather than in an external file. This element is identical to the
manifest task, but the file and mode attributes must be omitted.
If both an inline manifest and an external file are both specified, the manifests are merged.
When using inline manifests, the Jar task will check whether the manifest contents have changed (i.e. the manifest as specified is different in any way from the
manifest that exists in the Jar, if it exists. If the manifest values have changed the jar will be updated or rebuilt, as appropriate.
indexjars
The nested indexjars element specifies a PATH like structure. Its content is completely ignored unless you set the index attribute of the task to true.
The index created by this task will contain indices for the archives contained in this path, the names used for the archives depend on your manifest:
21/10/2014 10:42
file:///D:/eclipse/documentation/Ant/jar.html
If the generated jar's manifest contains no Class-Path attribute, the file name without any leading directory path will be used and all parts of the path will get
indexed.
If the manifest contains a Class-Path attribute, this task will try to guess which part of the Class-Path belongs to a given archive. If it cannot guess a name, the
archive will be skipped, otherwise the name listed inside the Class-Path attribute will be used.
This task will not create any index entries for archives that are empty or only contain files inside the META-INF directory unless the indexmetainf attribute has
been set to true.
service
The nested service element specifies a service. Services are described by http://download.oracle.com/javase/1.5.0/docs/guide/jar/jar.html#Service%20Provider. The
approach is to have providers JARs include files named by the service provided, for example, META-INF/services/javax.script.ScriptEngineFactory which can
include implementation class names, one per line (usually just one per JAR). The name of the service is set by the "type" attribute. The classname implementing the
service is the the "provider" attribute, or it one wants to specify a number of classes that implement the service, by "provider" nested elements.
The provider classname is specified either by the "provider" attribute, or by a nested <provider> element, which has a single "classname" attribute. If a JAR file has
more that one implementation of the service, a number of nested <provider> elements may be used.
Examples
Simple
jars all files in the ${build}/classes directory into a file called app.jar in the ${dist}/lib directory.
With filters
<jar destfile="${dist}/lib/app.jar"
basedir="${build}/classes"
excludes="**/Test.class"
21/10/2014 10:42
file:///D:/eclipse/documentation/Ant/jar.html
/>
jars all files in the ${build}/classes directory into a file called app.jar in the ${dist}/lib directory. Files with the name Test.class are excluded.
<jar destfile="${dist}/lib/app.jar"
basedir="${build}/classes"
includes="mypackage/test/**"
excludes="**/Test.class"
/>
jars all files in the ${build}/classes directory into a file called app.jar in the ${dist}/lib directory. Only files under the directory mypackage/test are used,
and files with the name Test.class are excluded.
Multiple filesets
<jar destfile="${dist}/lib/app.jar">
<fileset dir="${build}/classes"
excludes="**/Test.class"
/>
<fileset dir="${src}/resources"/>
</jar>
jars all files in the ${build}/classes directory and also in the ${src}/resources directory together into a file called app.jar in the ${dist}/lib directory. Files
with the name Test.class are excluded. If there are files such as ${build}/classes/mypackage/MyClass.class and ${src}/resources/mypackage/image.gif,
they will appear in the same directory in the JAR (and thus be considered in the same package by Java).
Merging archives
<jar destfile="build/main/checksites.jar">
<fileset dir="build/main/classes"/>
<zipfileset includes="**/*.class" src="lib/main/some.jar"/>
<manifest>
<attribute name="Main-Class"
value="com.acme.checksites.Main"/>
</manifest>
</jar>
Creates an executable jar file with a main class "com.acme.checksites.Main", and embeds all the classes from the jar lib/main/some.jar.
<jar destfile="build/main/checksites.jar">
<fileset dir="build/main/classes"/>
<restrict>
<name name="**/*.class"/>
21/10/2014 10:42
file:///D:/eclipse/documentation/Ant/jar.html
<archives>
<zips>
<fileset dir="lib/main" includes="**/*.jar"/>
</zips>
</archives>
</restrict>
<manifest>
<attribute name="Main-Class"
value="com.acme.checksites.Main"/>
</manifest>
</jar>
Creates an executable jar file with a main class "com.acme.checksites.Main", and embeds all the classes from all the jars in lib/main.
Inline manifest
This is an example of an inline manifest specification including the version of the build program (Implementation-Version). Note that the Built-By attribute will take
the value of the Ant property ${user.name}. The manifest produced by the above would look like this:
Manifest-Version: 1.0
Built-By: conor
Implementation-Vendor: ACME inc.
Implementation-Title: GreatProduct
Implementation-Version: 1.0.0beta2
Created-By: Apache Ant 1.7.0
Name: common/MyClass.class
Sealed: false
21/10/2014 10:42
file:///D:/eclipse/documentation/Ant/jar.html
Service Provider
The following shows how to create a jar file specifing a service with an implementation of the JDK6 scripting interface:
<jar jarfile="pinky.jar">
<fileset dir="build/classes"/>
<service type="javax.script.ScriptEngineFactory"
provider="org.acme.PinkyLanguage"/>
</jar>
The following shows how to create a jar file specifing a service with two implementations of the JDK6 scripting interface:
<jar jarfile="pinkyandbrain.jar">
<fileset dir="classes"/>
<service type="javax.script.ScriptEngineFactory">
<provider classname="org.acme.PinkyLanguage"/>
<provider classname="org.acme.BrainLanguage"/>
</service>
</jar>
21/10/2014 10:42