org.apache.james.mime4j.util
Class StringArrayMap

java.lang.Object
  extended by org.apache.james.mime4j.util.StringArrayMap
All Implemented Interfaces:
java.io.Serializable

public class StringArrayMap
extends java.lang.Object
implements java.io.Serializable

An object, which may be used to implement header, or parameter maps. The maps keys are the header or parameter names. The maps values are strings (single value), lists, or arrays.

Note that this class is not directly used anywhere in Mime4j. Instead a user might choose to use it instead of Header and Field in a custom ContentHandler implementation. See also MIME4j-24.

See Also:
Serialized Form

Constructor Summary
StringArrayMap()
           
 
Method Summary
protected  void addMapValue(java.util.Map<java.lang.String,java.lang.Object> pMap, java.lang.String pName, java.lang.String pValue)
          Adds a value to the given map.
 void addValue(java.lang.String pName, java.lang.String pValue)
          Adds a new name/value pair.
static java.util.Map<java.lang.String,java.lang.String[]> asMap(java.util.Map<java.lang.String,java.lang.Object> pMap)
          Converts the given map into a string array map: The map values are string arrays.
static java.lang.String asString(java.lang.Object pValue)
          Converts the given object into a string.
static java.lang.String[] asStringArray(java.lang.Object pValue)
          Converts the given object into a string array.
static java.util.Enumeration<java.lang.String> asStringEnum(java.lang.Object pValue)
          Converts the given object into a string enumeration.
protected  java.lang.String convertName(java.lang.String pName)
          Lower cases the given name.
 java.util.Map<java.lang.String,java.lang.String[]> getMap()
          Returns an unmodifiable map of name/value pairs.
 java.lang.String[] getNameArray()
          Returns the set of registered names.
 java.util.Enumeration<java.lang.String> getNames()
          Returns the set of registered names as an enumeration.
 java.lang.String getValue(java.lang.String pName)
          Returns the requested value.
 java.util.Enumeration<java.lang.String> getValueEnum(java.lang.String pName)
          Returns the requested values as an enumeration.
 java.lang.String[] getValues(java.lang.String pName)
          Returns the requested values as a string array.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StringArrayMap

public StringArrayMap()
Method Detail

asString

public static java.lang.String asString(java.lang.Object pValue)

Converts the given object into a string. The object may be either of:


asStringArray

public static java.lang.String[] asStringArray(java.lang.Object pValue)

Converts the given object into a string array. The object may be either of:


asStringEnum

public static java.util.Enumeration<java.lang.String> asStringEnum(java.lang.Object pValue)

Converts the given object into a string enumeration. The object may be either of:


asMap

public static java.util.Map<java.lang.String,java.lang.String[]> asMap(java.util.Map<java.lang.String,java.lang.Object> pMap)
Converts the given map into a string array map: The map values are string arrays.


addMapValue

protected void addMapValue(java.util.Map<java.lang.String,java.lang.Object> pMap,
                           java.lang.String pName,
                           java.lang.String pValue)
Adds a value to the given map.


convertName

protected java.lang.String convertName(java.lang.String pName)
Lower cases the given name.


getValue

public java.lang.String getValue(java.lang.String pName)
Returns the requested value.


getValues

public java.lang.String[] getValues(java.lang.String pName)
Returns the requested values as a string array.


getValueEnum

public java.util.Enumeration<java.lang.String> getValueEnum(java.lang.String pName)
Returns the requested values as an enumeration.


getNames

public java.util.Enumeration<java.lang.String> getNames()
Returns the set of registered names as an enumeration.

See Also:
getNameArray()

getMap

public java.util.Map<java.lang.String,java.lang.String[]> getMap()
Returns an unmodifiable map of name/value pairs. The map keys are the lower cased parameter/header names. The map values are string arrays.


addValue

public void addValue(java.lang.String pName,
                     java.lang.String pValue)
Adds a new name/value pair.


getNameArray

public java.lang.String[] getNameArray()
Returns the set of registered names.

See Also:
getNames()


Copyright © 2004-2009 The Apache Software Foundation. All Rights Reserved.