Attributes

public class Attributes extends Object
implements Map<Object, Object> Cloneable

The Attributes class maps Manifest attribute names to associated string values. Valid attribute names are case-insensitive, are restricted to the ASCII characters in the set [0-9a-zA-Z_-], and cannot exceed 70 characters in length. Attribute values can contain any characters and will be UTF8-encoded when written to the output stream. See the JAR File Specification for more information about valid attribute names and values.

See Also

• Manifest

Nested Class Summary

class

Attributes.Name

The Attributes.Name class represents an attribute name stored in this Map.

Field Summary

protected Map<Object, Object>

map

The attribute name-value mappings.

Public Constructor Summary

	Attributes() Constructs a new, empty Attributes object with default size.
	Attributes(int size) Constructs a new, empty Attributes object with the specified initial size.
	Attributes(Attributes attr) Constructs a new Attributes object with the same attribute name-value mappings as in the specified Attributes.

Public Method Summary

void	clear() Removes all attributes from this Map.
Object	clone() Returns a copy of the Attributes, implemented as follows: public Object clone() { return new Attributes(this); } Since the attribute names and values are themselves immutable, the Attributes returned can be safely modified without affecting the original.
boolean	containsKey(Object name) Returns true if this Map contains the specified attribute name (key).
boolean	containsValue(Object value) Returns true if this Map maps one or more attribute names (keys) to the specified value.
Set<Entry<Object, Object>>	entrySet() Returns a Collection view of the attribute name-value mappings contained in this Map.
boolean	equals(Object o) Compares the specified Attributes object with this Map for equality.
Object	get(Object name) Returns the value of the specified attribute name, or null if the attribute name was not found.
String	getValue(String name) Returns the value of the specified attribute name, specified as a string, or null if the attribute was not found.
String	getValue(Attributes.Name name) Returns the value of the specified Attributes.Name, or null if the attribute was not found.
int	hashCode() Returns the hash code value for this Map.
boolean	isEmpty() Returns true if this Map contains no attributes.
Set<Object>	keySet() Returns a Set view of the attribute names (keys) contained in this Map.
Object	put(Object name, Object value) Associates the specified value with the specified attribute name (key) in this Map.
void	putAll(Map<?, ?> attr) Copies all of the attribute name-value mappings from the specified Attributes to this Map.
String	putValue(String name, String value) Associates the specified value with the specified attribute name, specified as a String.
Object	remove(Object name) Removes the attribute with the specified name (key) from this Map.
int	size() Returns the number of attributes in this Map.
Collection<Object>	values() Returns a Collection view of the attribute values contained in this Map.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

From interface java.util.Map

abstract void	clear() Removes all of the mappings from this map (optional operation).
Object	compute(Object key, BiFunction<? super K, ? super V, ? extends V> remappingFunction) Attempts to compute a mapping for the specified key and its current mapped value (or null if there is no current mapping).
Object	computeIfAbsent(Object key, Function<? super K, ? extends V> mappingFunction) If the specified key is not already associated with a value (or is mapped to null), attempts to compute its value using the given mapping function and enters it into this map unless null.
Object	computeIfPresent(Object key, BiFunction<? super K, ? super V, ? extends V> remappingFunction) If the value for the specified key is present and non-null, attempts to compute a new mapping given the key and its current mapped value.
abstract boolean	containsKey(Object key) Returns true if this map contains a mapping for the specified key.
abstract boolean	containsValue(Object value) Returns true if this map maps one or more keys to the specified value.
abstract Set<Entry<Object, Object>>	entrySet() Returns a Set view of the mappings contained in this map.
abstract boolean	equals(Object o) Compares the specified object with this map for equality.
void	forEach(BiConsumer<? super K, ? super V> action) Performs the given action for each entry in this map until all entries have been processed or the action throws an exception.
abstract Object	get(Object key) Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
Object	getOrDefault(Object key, Object defaultValue) Returns the value to which the specified key is mapped, or defaultValue if this map contains no mapping for the key.
abstract int	hashCode() Returns the hash code value for this map.
abstract boolean	isEmpty() Returns true if this map contains no key-value mappings.
abstract Set<Object>	keySet() Returns a Set view of the keys contained in this map.
Object	merge(Object key, Object value, BiFunction<? super V, ? super V, ? extends V> remappingFunction) If the specified key is not already associated with a value or is associated with null, associates it with the given non-null value.
abstract Object	put(Object key, Object value) Associates the specified value with the specified key in this map (optional operation).
abstract void	putAll(Map<? extends K, ? extends V> m) Copies all of the mappings from the specified map to this map (optional operation).
Object	putIfAbsent(Object key, Object value) If the specified key is not already associated with a value (or is mapped to null) associates it with the given value and returns null, else returns the current value.
boolean	remove(Object key, Object value) Removes the entry for the specified key only if it is currently mapped to the specified value.
abstract Object	remove(Object key) Removes the mapping for a key from this map if it is present (optional operation).
boolean	replace(Object key, Object oldValue, Object newValue) Replaces the entry for the specified key only if currently mapped to the specified value.
Object	replace(Object key, Object value) Replaces the entry for the specified key only if it is currently mapped to some value.
void	replaceAll(BiFunction<? super K, ? super V, ? extends V> function) Replaces each entry's value with the result of invoking the given function on that entry until all entries have been processed or the function throws an exception.
abstract int	size() Returns the number of key-value mappings in this map.
abstract Collection<Object>	values() Returns a Collection view of the values contained in this map.

Fields

protected Map<Object, Object> map

The attribute name-value mappings.

Public Constructors

public Attributes ()

Constructs a new, empty Attributes object with default size.

public Attributes (int size)

Constructs a new, empty Attributes object with the specified initial size.

Parameters

size	the initial number of attributes

public Attributes (Attributes attr)

Constructs a new Attributes object with the same attribute name-value mappings as in the specified Attributes.

Parameters

attr	the specified Attributes

Public Methods

public void clear ()

Removes all attributes from this Map.

public Object clone ()

Returns a copy of the Attributes, implemented as follows:

     public Object clone() { return new Attributes(this); }
 

Since the attribute names and values are themselves immutable, the Attributes returned can be safely modified without affecting the original.

Returns

• a copy of this object.

public boolean containsKey (Object name)

Returns true if this Map contains the specified attribute name (key).

Parameters

name	the attribute name

Returns

• true if this Map contains the specified attribute name

public boolean containsValue (Object value)

Returns true if this Map maps one or more attribute names (keys) to the specified value.

Parameters

value	the attribute value

Returns

• true if this Map maps one or more attribute names to the specified value

public Set<Entry<Object, Object>> entrySet ()

Returns a Collection view of the attribute name-value mappings contained in this Map.

Returns

• a set view of the mappings contained in this map

public boolean equals (Object o)

Compares the specified Attributes object with this Map for equality. Returns true if the given object is also an instance of Attributes and the two Attributes objects represent the same mappings.

Parameters

o	the Object to be compared

Returns

• true if the specified Object is equal to this Map

public Object get (Object name)

Returns the value of the specified attribute name, or null if the attribute name was not found.

Parameters

name	the attribute name

Returns

• the value of the specified attribute name, or null if not found.

public String getValue (String name)

Returns the value of the specified attribute name, specified as a string, or null if the attribute was not found. The attribute name is case-insensitive.

This method is defined as:

      return (String)get(new Attributes.Name((String)name));
 

Parameters

name	the attribute name as a string

Returns

• the String value of the specified attribute name, or null if not found.

Throws

IllegalArgumentException	if the attribute name is invalid

public String getValue (Attributes.Name name)

Returns the value of the specified Attributes.Name, or null if the attribute was not found.

This method is defined as:

     return (String)get(name);
 

Parameters

name	the Attributes.Name object

Returns

• the String value of the specified Attribute.Name, or null if not found.

public int hashCode ()

Returns the hash code value for this Map.

Returns

• this object's hash code.

public boolean isEmpty ()

Returns true if this Map contains no attributes.

Returns

• true if this map contains no key-value mappings

public Set<Object> keySet ()

Returns a Set view of the attribute names (keys) contained in this Map.

Returns

• a set view of the keys contained in this map

public Object put (Object name, Object value)

Associates the specified value with the specified attribute name (key) in this Map. If the Map previously contained a mapping for the attribute name, the old value is replaced.

Parameters

name	the attribute name
value	the attribute value

Returns

• the previous value of the attribute, or null if none

Throws

ClassCastException	if the name is not a Attributes.Name or the value is not a String

public void putAll (Map<?, ?> attr)

Copies all of the attribute name-value mappings from the specified Attributes to this Map. Duplicate mappings will be replaced.

Parameters

attr	the Attributes to be stored in this map

Throws

ClassCastException	if attr is not an Attributes

public String putValue (String name, String value)

Associates the specified value with the specified attribute name, specified as a String. The attributes name is case-insensitive. If the Map previously contained a mapping for the attribute name, the old value is replaced.

This method is defined as:

      return (String)put(new Attributes.Name(name), value);
 

Parameters

name	the attribute name as a string
value	the attribute value

Returns

• the previous value of the attribute, or null if none

Throws

IllegalArgumentException	if the attribute name is invalid

public Object remove (Object name)

Removes the attribute with the specified name (key) from this Map. Returns the previous attribute value, or null if none.

Parameters

name	attribute name

Returns

• the previous value of the attribute, or null if none

public int size ()

Returns the number of attributes in this Map.

Returns

• the number of key-value mappings in this map

public Collection<Object> values ()

Returns a Collection view of the attribute values contained in this Map.

Returns

• a collection view of the values contained in this map