Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Class java.util.jar.Attributes

java.lang.Object
    |
    +----java.util.jar.Attributes

public class Attributes
extends Object
implements Map, Cloneable
The Attributes class maps Manifest attribute names to associated string values. Attribute names are case-insensitive and restricted to the ASCII characters in the set [0-9a-zA-Z_-]. Attribute values can contain any characters and will be UTF8-encoded when written to the output stream.

Since:
JDK1.2
See Also:
Manifest

Inner Class Summary
static   Attributes.Name
The Attributes.Name class represents an attribute name stored in this Map.
 

Field Summary
Map  amap
The attribute name-value mappings.
 

Constructor Summary
 Attributes()
Constructs a new, empty Attributes object.
 Attributes(Attributes attr)
Constructs a new Attributes object with the same attribute name-value mappings as in the specified Attributes.
 

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  entries()
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  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  values()
Returns a Collection view of the attribute values contained in this Map.
 
Methods inherited from class java.lang.Object
 clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

amap

protected Map amap
The attribute name-value mappings.
Constructor Detail

Attributes

public Attributes()
Constructs a new, empty Attributes object.

Attributes

public Attributes(Attributes attr)
Constructs a new Attributes object with the same attribute name-value mappings as in the specified Attributes.
Method Detail

get

public Object get(Object name)
Returns the value of the specified attribute name, or null if the attribute name was not found.
Implements:
get in interface Map
Parameters:
name - the attribute name
Throws:
ClassCastException - if name is not a Attributes.Name
NullPointerException - if name is null

getValue

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 merely shorthand for the expression:

	    (String)get(new Attributes.Name((String)name));
 
Parameters:
name - the attribute name as a string
Throws:
NullPointerException - if the name is null

getValue

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 merely shorthand for the expression:

     (String)get(name)
 
Parameters:
name - the Attributes.Name object
Throws:
NullPointerException - if name is null

put

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.
Implements:
put in interface Map
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

putValue

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 merely shorthand for the expression:

	    (String)put(new Attributes.Name(name), value);
 
Parameters:
the - attribute name as a string
value - the attribute value
Throws:
IllegalArgumentException - if the attribute name is invalid
NullPointerException - if name or value is null

remove

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.
Implements:
remove in interface Map
Parameters:
name - attribute name
Throws:
ClassCastException - if the name is not a Attributes.Name
NullPointerException - if the name is null

containsValue

public boolean containsValue(Object value)
Returns true if this Map maps one or more attribute names (keys) to the specified value.
Implements:
containsValue in interface Map
Parameters:
value - the attribute value

containsKey

public boolean containsKey(Object name)
Returns true if this Map contains the specified attribute name (key).
Implements:
containsKey in interface Map
Parameters:
name - the attribute name
Throws:
ClassCastException - if the name is not a Attributes.Name
NullPointerException - if the name is null

putAll

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.
Implements:
putAll in interface Map
Parameters:
attr - the Attributes to be stored in this map
Throws:
ClassCastException - if attr is not an instance of Attributes
NullPointerException - if attr is null

clear

public void clear()
Removes all attributes from this Map.
Implements:
clear in interface Map

size

public int size()
Returns the number of attributes in this Map.
Implements:
size in interface Map

isEmpty

public boolean isEmpty()
Returns true if this Map contains no attributes.
Implements:
isEmpty in interface Map

keySet

public Set keySet()
Returns a Set view of the attribute names (keys) contained in this Map.
Implements:
keySet in interface Map

values

public Collection values()
Returns a Collection view of the attribute values contained in this Map.
Implements:
values in interface Map

entries

public Set entries()
Returns a Collection view of the attribute name-value mappings contained in this Map.
Implements:
entries in interface Map

equals

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.
Implements:
equals in interface Map
Parameters:
o - the Object to be compared
Returns:
true if the specified Object is equal to this Map
Overrides:
equals in class Object

hashCode

public int hashCode()
Returns the hash code value for this Map.
Implements:
hashCode in interface Map
Overrides:
hashCode in class Object

clone

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.
Overrides:
clone in class Object

Contents | Package | Class | Tree | Deprecated | Index | Help Java 1.2 Beta 3
PREV | NEXT SHOW LISTS | HIDE LISTS

Submit a bug or feature
Submit comments/suggestions about new javadoc look.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.