org.codehaus.plexus.archiver.jar

Class ModularJarArchiver

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.codehaus.plexus.archiver.AbstractArchiver

org.codehaus.plexus.archiver.zip.AbstractZipArchiver

org.codehaus.plexus.archiver.zip.ZipArchiver

org.codehaus.plexus.archiver.jar.JarArchiver

org.codehaus.plexus.archiver.jar.ModularJarArchiver

All Implemented Interfaces:

Archiver, FinalizerEnabled, org.codehaus.plexus.logging.LogEnabled, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Direct Known Subclasses:

JarToolModularJarArchiver

public abstract class ModularJarArchiver
extends JarArchiver

Base class for creating modular JAR archives. Subclasses are required to be able to handle both JAR archives with module descriptor (modular JAR) and without ("regular" JAR). That would allow clients of this class to use it without prior knowledge if the classes they are going to add are part of module (contain module descriptor class) or not.

The class allows you to set the module main class (setModuleMainClass(String)), but if it is not set or it is set to null, then the Main-Class attribute of the JAR manifest is used (if present) to set the module main class.

Since:

3.6

Nested Class Summary

Nested classes/interfaces inherited from class org.codehaus.plexus.archiver.jar.JarArchiver

JarArchiver.FilesetManifestConfig

Field Summary

Fields inherited from class org.codehaus.plexus.archiver.zip.AbstractZipArchiver

addedDirs, addingNewFiles, archiveType, doubleFilePass, duplicate, entries, skipWriting, zipArchiveOutputStream

Fields inherited from interface org.codehaus.plexus.archiver.Archiver

DEFAULT_DIR_MODE, DEFAULT_FILE_MODE, DEFAULT_SYMLILNK_MODE, DUPLICATES_ADD, DUPLICATES_FAIL, DUPLICATES_PRESERVE, DUPLICATES_SKIP, DUPLICATES_VALID_BEHAVIORS, ROLE

Constructor Summary

Constructors

Constructor and Description
ModularJarArchiver()

Method Summary

Methods

Modifier and Type	Method and Description
protected Manifest	createManifest() Creates the manifest to be added to the JAR archive.
protected String	getManifestMainClass() Returns the "Main-Class" attribute of the manifest added to the archive.
String	getModuleMainClass()
String	getModuleVersion()
void	reset() reset to default values.
void	setModuleMainClass(String moduleMainClass) Sets the module main class.
void	setModuleVersion(String moduleVersion) Sets the module version.

Methods inherited from class org.codehaus.plexus.archiver.jar.JarArchiver

addConfiguredIndexJars, addConfiguredManifest, cleanUp, createEmptyZip, finalizeZipOutputStream, findJarName, grabFilesAndDirs, hasVirtualFiles, initZipOutputStream, setFilesetmanifest, setIndex, setManifest, setManifestEncoding, writeIndexLikeList, zipFile

Methods inherited from class org.codehaus.plexus.archiver.zip.AbstractZipArchiver

addResources, close, createInputStreamSupplier, execute, getArchiveType, getComment, getEncoding, isCompress, isFilesonly, isInUpdateMode, isRecompressAddedZips, isSupportingForced, revert, setComment, setCompress, setEncoding, setFilesonly, setRecompressAddedZips, setUpdateMode, zipDir, zipFile

Methods inherited from class org.codehaus.plexus.archiver.AbstractArchiver

addArchivedFileSet, addArchivedFileSet, addArchivedFileSet, addArchivedFileSet, addArchivedFileSet, addArchivedFileSet, addArchiveFinalizer, addDirectory, addDirectory, addDirectory, addDirectory, addFile, addFile, addFileSet, addResource, addResources, addSymlink, addSymlink, asArchiveEntry, asResourceCollection, checkForced, contextualize, createArchive, getDefaultDirectoryMode, getDefaultFileMode, getDestFile, getDirectoryMode, getDuplicateBehavior, getFileMode, getFiles, getIncludeEmptyDirs, getLogger, getOverrideDirectoryMode, getOverrideFileMode, getRawDefaultFileMode, getResources, isForced, isIgnorePermissions, isUptodate, isUseJvmChmod, postCreateArchive, runArchiveFinalizers, setArchiveFinalizers, setDefaultDirectoryMode, setDefaultFileMode, setDestFile, setDirectoryMode, setDotFileDirectory, setDuplicateBehavior, setFileMode, setForced, setIgnorePermissions, setIncludeEmptyDirs, setUseJvmChmod, validate

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

ModularJarArchiver

public ModularJarArchiver()

Method Detail

getModuleMainClass

public String getModuleMainClass()

setModuleMainClass

public void setModuleMainClass(String moduleMainClass)

Sets the module main class. Ignored if the JAR file does not contain module descriptor.

Note that implementations may choose to replace the value set in the manifest as well.

Parameters:

moduleMainClass - the module main class.

getModuleVersion

public String getModuleVersion()

setModuleVersion

public void setModuleVersion(String moduleVersion)

Sets the module version. Ignored if the JAR file does not contain module descriptor.

Parameters:

moduleVersion - the module version.

getManifestMainClass

protected String getManifestMainClass()

Returns the "Main-Class" attribute of the manifest added to the archive. null if there is no manifest or the attribute is not set.

Returns:

the "Main-Class" attribute of the manifest

createManifest

protected Manifest createManifest()

Description copied from class: JarArchiver

Creates the manifest to be added to the JAR archive. Sub-classes may choose to override this method in order to inspect or modify the JAR manifest file.

Overrides:

createManifest in class JarArchiver

Returns:

the manifest for the JAR archive.

reset

public void reset()

Description copied from class: JarArchiver

reset to default values.

Overrides:

reset in class JarArchiver

See Also:

AbstractZipArchiver.reset()