Package org.apache.juneau.utils

Class ManifestFile

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<String,Object>

org.apache.juneau.collections.JsonMap

org.apache.juneau.utils.ManifestFile

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

public class ManifestFile
extends JsonMap

Utility class for working with Jar manifest files.

Copies the contents of a Manifest into an JsonMap so that the various convenience methods on that class can be used to retrieve values.

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Field Summary

Fields inherited from class org.apache.juneau.collections.JsonMap

EMPTY_MAP

Constructor Summary

Constructors

Constructor	Description
ManifestFile(File f)	Create an instance of this class from a manifest file on the file system.
ManifestFile(InputStream is)	Create an instance of this class loaded from the contents of an input stream.
ManifestFile(Reader r)	Create an instance of this class loaded from the contents of a reader.
ManifestFile(Class<?> c)	Finds and loads the manifest file of the jar file that the specified class is contained within.
ManifestFile(Path path)	Create an instance of this class from a manifest path on the file system.
ManifestFile(Manifest f)	Create an instance of this class from a Manifest object.

Method Summary

Modifier and Type	Method	Description
ManifestFile	append(String key, Object value)	Adds an entry to this map.
ManifestFile	append(Map<String,Object> values)	Appends all the entries in the specified map to this map.
ManifestFile	appendIf(boolean flag, String key, Object value)	Add if flag is true.
ManifestFile	filtered(Predicate<Object> value)	Enables filtering based on a predicate test.
ManifestFile	inner(Map<String,Object> inner)	Set an inner map in this map to allow for chained get calls.
ManifestFile	keepAll(String... keys)	The opposite of JsonMap.removeAll(String...).
ManifestFile	modifiable()	Returns a modifiable copy of this map if it's unmodifiable.
ManifestFile	session(BeanSession session)	Override the default bean session used for converting POJOs.
ManifestFile	setBeanSession(BeanSession value)	Sets the BeanSession currently associated with this map.
String	toString()
ManifestFile	unmodifiable()	Returns an unmodifiable copy of this map if it's modifiable.

Methods inherited from class org.apache.juneau.collections.JsonMap

appendFirst, appendIf, appendIfAbsent, appendIfAbsentIf, asJson, asReadableString, asString, asString, cast, cast, containsKey, containsKeyNotEmpty, containsOuterKey, create, deleteAt, entrySet, exclude, filtered, filteredMap, filteredMap, find, find, findBoolean, findInt, findKeyIgnoreCase, findList, findLong, findMap, findString, get, get, get, getAt, getAt, getBeanSession, getBoolean, getBoolean, getClassMeta, getFirstKey, getInt, getInt, getList, getList, getList, getList, getLong, getLong, getMap, getMap, getMap, getMap, getString, getString, getStringArray, getStringArray, getSwapped, getWithDefault, getWithDefault, getWithDefault, include, isUnmodifiable, keySet, of, of, ofJson, ofJson, ofText, ofText, postAt, put, putAt, putJson, removeAll, removeAll, removeBoolean, removeBoolean, removeInt, removeInt, removeString, removeString, removeWithDefault, writeTo

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, forEach, getOrDefault, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, isEmpty, merge, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, hashCode, isEmpty, merge, putAll, putIfAbsent, remove, remove, replace, replace, size

Constructor Details

ManifestFile

public ManifestFile(Class<?> c)
             throws IOException

Finds and loads the manifest file of the jar file that the specified class is contained within.

Parameters:

c - The class to get the manifest file of.

Throws:

IOException - If a problem occurred while trying to read the manifest file.

ManifestFile

public ManifestFile(File f)
             throws IOException

Create an instance of this class from a manifest file on the file system.

Parameters:

f - The manifest file.

Throws:

IOException - If a problem occurred while trying to read the manifest file.

ManifestFile

public ManifestFile(InputStream is)
             throws IOException

Create an instance of this class loaded from the contents of an input stream.

Note that the input must end in a newline to pick up the last line!

Parameters:

is - The manifest file contents.

Throws:

IOException - If a problem occurred while trying to read the manifest file.

ManifestFile

public ManifestFile(Manifest f)

Create an instance of this class from a Manifest object.

Parameters:

f - The manifest to read from.

ManifestFile

public ManifestFile(Path path)
             throws IOException

Create an instance of this class from a manifest path on the file system.

Parameters:

path - The manifest path.

Throws:

IOException - If a problem occurred while trying to read the manifest path.

ManifestFile

public ManifestFile(Reader r)
             throws IOException

Create an instance of this class loaded from the contents of a reader.

Note that the input must end in a newline to pick up the last line!

Parameters:

r - The manifest file contents.

Throws:

IOException - If a problem occurred while trying to read the manifest file.

Method Details

append

public ManifestFile append(Map<String,Object> values)

Description copied from class: JsonMap

Appends all the entries in the specified map to this map.

Overrides:

append in class JsonMap

Parameters:

values - The map to copy. Can be null.

Returns:

This object.

append

public ManifestFile append(String key,
 Object value)

Description copied from class: JsonMap

Adds an entry to this map.

Overrides:

append in class JsonMap

Parameters:

key - The key.

value - The value.

Returns:

This object.

appendIf

public ManifestFile appendIf(boolean flag,
 String key,
 Object value)

Description copied from class: JsonMap

Add if flag is true.

Overrides:

appendIf in class JsonMap

Parameters:

flag - The flag to check.

key - The key.

value - The value.

Returns:

This object.

filtered

public ManifestFile filtered(Predicate<Object> value)

Description copied from class: JsonMap

Enables filtering based on a predicate test.

If the predicate evaluates to false on values added to this map, the entry will be skipped.

Overrides:

filtered in class JsonMap

Parameters:

value - The value tester predicate.

Returns:

This object.

inner

public ManifestFile inner(Map<String,Object> inner)

Description copied from class: JsonMap

Set an inner map in this map to allow for chained get calls.

If JsonMap.get(Object) returns null, then JsonMap.get(Object) will be called on the inner map.

In addition to providing the ability to chain maps, this method also provides the ability to wrap an existing map inside another map so that you can add entries to the outer map without affecting the values on the inner map.

JsonMap map1 = JsonMap.ofJson("{foo:1}"); JsonMap map2 = JsonMap.of().setInner(map1); map2.put("foo", 2); // Overwrite the entry int foo1 = map1.getInt("foo"); // foo1 == 1 int foo2 = map2.getInt("foo"); // foo2 == 2

Overrides:

inner in class JsonMap

Parameters:

inner - The inner map. Can be null to remove the inner map from an existing map.

Returns:

This object.

keepAll

public ManifestFile keepAll(String... keys)

Description copied from class: JsonMap

The opposite of JsonMap.removeAll(String...).

Discards all keys from this map that aren't in the specified list.

Overrides:

keepAll in class JsonMap

Parameters:

keys - The keys to keep.

Returns:

This map.

modifiable

public ManifestFile modifiable()

Description copied from class: JsonMap

Returns a modifiable copy of this map if it's unmodifiable.

Overrides:

modifiable in class JsonMap

Returns:

A modifiable copy of this map if it's unmodifiable, or this map if it is already modifiable.

session

public ManifestFile session(BeanSession session)

Description copied from class: JsonMap

Override the default bean session used for converting POJOs.

Default is BeanContext.DEFAULT, which is sufficient in most cases.

Useful if you're serializing/parsing beans with transforms defined.

Overrides:

session in class JsonMap

Parameters:

session - The new bean session.

Returns:

This object.

setBeanSession

public ManifestFile setBeanSession(BeanSession value)

Description copied from class: JsonMap

Sets the BeanSession currently associated with this map.

Overrides:

setBeanSession in class JsonMap

Parameters:

value - The BeanSession currently associated with this map.

Returns:

This object.

toString

public String toString()

Overrides:

toString in class JsonMap

unmodifiable

public ManifestFile unmodifiable()

Description copied from class: JsonMap

Returns an unmodifiable copy of this map if it's modifiable.

Overrides:

unmodifiable in class JsonMap

Returns:

An unmodifiable copy of this map if it's modifiable, or this map if it is already unmodifiable.