dev.jeka.core.api.java

Class JkManifest

java.lang.Object

dev.jeka.core.api.java.JkManifest

public final class JkManifest
extends java.lang.Object

Wrapper class on Manifest providing utility methods.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BUILD_JDK The JDK version who was running while building this manifest.
static java.lang.String	BUILD_TIME
static java.lang.String	CREATED_BY The software that has created this manifest.
static java.lang.String	IMPLEMENTATION_TITLE The title of the implementation.
static java.lang.String	IMPLEMENTATION_VENDOR The version of the implementation.
static java.lang.String	IMPLEMENTATION_VERSION The version of the implementation.
static java.lang.String	STANDARD_LOCATION The path where generally belongs all manifest past (relative to archive root)

Method Summary

Modifier and Type	Method and Description
JkManifest	addBuildInfo() Fills this manifest with contextual infoString : CREATED_BY, BUILT_BY and BUILD_JDK
JkManifest	addImplementationInfo(JkModuleId moduleId, JkVersion version) Adds implementation-* information to the JkManifest.
JkManifest	addMainAttribute(java.util.jar.Attributes.Name key, java.lang.String value) Adds the specified attributes in the "main" attributes section.
JkManifest	addMainAttribute(java.lang.String key, java.lang.String value)
JkManifest	addMainClass(java.lang.String value) Adds the 'Main-Class' attribute to this manifest.
java.lang.String	asString()
java.lang.String	asTrimedString() Returns a trimmed string representation of the manifest, removing tailing empty line
java.lang.String	getMainAttribute(java.util.jar.Attributes.Name name) Returns the value of the main attribute having the specified name.
java.lang.String	getMainAttribute(java.lang.String key) Returns the value of the main attribute having the specified name.
java.util.jar.Manifest	getManifest() Returns the underlying JDK Manifest object.
boolean	isEmpty() Returns true if this manifest has no entry or has only "Manifest-Version" entry.
JkManifest	loadFromClass(java.lang.Class<?> clazz) Loads the manifest from the jar or the base class directory the specified class belongs to.
JkManifest	loadFromFile(java.nio.file.Path file) Loads the manifest file from the specified path and set it as the underlying manifest.
JkManifest	loadFromInputStream(java.io.InputStream inputStream) Loads the manifest from the specified input stream and set it as the underlying manifest.
JkManifest	loadFromJar(java.nio.file.Path jar)
JkManifest	merge(java.util.jar.Manifest other) Adds attributes of the specified manifest to this one.
static JkManifest	of() Creates an empty JkManifest
JkManifest	set(java.util.jar.Manifest manifest) Set the underlying Manifest with the specified one.
void	writeTo(java.nio.file.Path file)
void	writeToStandardLocation(java.nio.file.Path classDir) Writes this manifest at the standard place (META-INF/MANIFEST.MF) of the specified directory.

Methods inherited from class java.lang.Object

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

Field Detail

STANDARD_LOCATION

public static final java.lang.String STANDARD_LOCATION

The path where generally belongs all manifest past (relative to archive root)

See Also:

Constant Field Values

BUILD_JDK

public static final java.lang.String BUILD_JDK

The JDK version who was running while building this manifest.

See Also:

Constant Field Values

BUILD_TIME

public static final java.lang.String BUILD_TIME

See Also:

Constant Field Values

CREATED_BY

public static final java.lang.String CREATED_BY

The software that has created this manifest. Normally "Jeka" along its version

See Also:

Constant Field Values

IMPLEMENTATION_TITLE

public static final java.lang.String IMPLEMENTATION_TITLE

The title of the implementation.

See Also:

Constant Field Values

IMPLEMENTATION_VERSION

public static final java.lang.String IMPLEMENTATION_VERSION

The version of the implementation.

See Also:

Constant Field Values

IMPLEMENTATION_VENDOR

public static final java.lang.String IMPLEMENTATION_VENDOR

The version of the implementation.

See Also:

Constant Field Values

Method Detail

of

public static JkManifest of()

Creates an empty JkManifest

getManifest

public java.util.jar.Manifest getManifest()

Returns the underlying JDK Manifest object.

set

public JkManifest set(java.util.jar.Manifest manifest)

Set the underlying Manifest with the specified one.

loadFromFile

public JkManifest loadFromFile(java.nio.file.Path file)

Loads the manifest file from the specified path and set it as the underlying manifest.

loadFromJar

public JkManifest loadFromJar(java.nio.file.Path jar)

loadFromInputStream

public JkManifest loadFromInputStream(java.io.InputStream inputStream)

Loads the manifest from the specified input stream and set it as the underlying manifest.

loadFromClass

public JkManifest loadFromClass(java.lang.Class<?> clazz)

Loads the manifest from the jar or the base class directory the specified class belongs to.

addMainAttribute

public JkManifest addMainAttribute(java.util.jar.Attributes.Name key,
                                   java.lang.String value)

Adds the specified attributes in the "main" attributes section. This method return this object.

addMainAttribute

public JkManifest addMainAttribute(java.lang.String key,
                                   java.lang.String value)

See Also:

#addMainAttribute(Name, String)

addMainClass

public JkManifest addMainClass(java.lang.String value)

Adds the 'Main-Class' attribute to this manifest. This method returns this object.

addImplementationInfo

public JkManifest addImplementationInfo(JkModuleId moduleId,
                                        JkVersion version)

Adds implementation-* information to the JkManifest. t.

addBuildInfo

public JkManifest addBuildInfo()

Fills this manifest with contextual infoString : CREATED_BY, BUILT_BY and BUILD_JDK

getMainAttribute

public java.lang.String getMainAttribute(java.lang.String key)

Returns the value of the main attribute having the specified name.

getMainAttribute

public java.lang.String getMainAttribute(java.util.jar.Attributes.Name name)

Returns the value of the main attribute having the specified name.

merge

public JkManifest merge(java.util.jar.Manifest other)

Adds attributes of the specified manifest to this one. This manifest attributes are overridden by those of the specified one if same attribute exist.

writeToStandardLocation

public void writeToStandardLocation(java.nio.file.Path classDir)

Writes this manifest at the standard place (META-INF/MANIFEST.MF) of the specified directory.

writeTo

public void writeTo(java.nio.file.Path file)

asString

public java.lang.String asString()

asTrimedString

public java.lang.String asTrimedString()

Returns a trimmed string representation of the manifest, removing tailing empty line

Returns:

a trimmed string representation of the manifest

isEmpty

public boolean isEmpty()

Returns true if this manifest has no entry or has only "Manifest-Version" entry.