NameValueList (jain-sip-ri 1.2.213 API)

java.lang.Object
- gov.nist.core.NameValueList

All Implemented Interfaces:

Serializable, Cloneable, Map<String,NameValue>
```
public class NameValueList
extends Object
implements Serializable, Cloneable, Map<String,NameValue>
```
Implements a simple NameValue association with a quick lookup function (via a hash map) the default behavior for this class is not thread safe. specify a constructor with boolean true to make this thread safe.

Version:

1.2

Author:

M. Ranganathan

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

NameValueList()
default constructor.

NameValueList(boolean sync)

Constructors
Constructor and Description
`NameValueList()` default constructor.
`NameValueList(boolean sync)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()`
`Object`	`clone()`
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`boolean`	`delete(String name)` Remove the element corresponding to this name.
`String`	`encode()` Encode the list in semicolon separated form.
`StringBuilder`	`encode(StringBuilder buffer)`
`Set<Map.Entry<String,NameValue>>`	`entrySet()`
`boolean`	`equals(Object otherObject)` Compare if two NameValue lists are equal.
`NameValue`	`get(Object key)`
`protected Map<String,NameValue>`	`getMap()`
`Iterator<String>`	`getNames()` Get a list of parameter names.
`NameValue`	`getNameValue(String name)` Get the NameValue record given a name.
`String`	`getParameter(String name)` Get the parameter as a String.
`String`	`getParameter(String name, boolean stripQuotes)` Get the parameter as a String.
`Object`	`getValue(String name)` Do a lookup on a given name and return value associated with it.
`Object`	`getValue(String name, boolean stripQuotes)` Do a lookup on a given name and return value associated with it.
`int`	`hashCode()`
`boolean`	`hasNameValue(String name)` Returns a boolean telling if this NameValueList has a record with this name
`boolean`	`isEmpty()` Return true if empty.
`Iterator<NameValue>`	`iterator()` Return an iterator for the name-value pairs of this list.
`Set<String>`	`keySet()`
`NameValue`	`put(String name, NameValue nameValue)`
`void`	`putAll(Map<? extends String,? extends NameValue> map)`
`NameValue`	`remove(Object key)`
`void`	`set(NameValue nv)` Set a namevalue object in this list.
`void`	`set(String name, Object value)` Set a namevalue object in this list.
`void`	`setSeparator(String separator)`
`int`	`size()` Return the size of the embedded map
`String`	`toString()`
`Collection<NameValue>`	`values()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - NameValueList
```
public NameValueList()
```
    default constructor.
  - NameValueList
```
public NameValueList(boolean sync)
```
- Method Detail
  - setSeparator
```
public void setSeparator(String separator)
```
  - encode
```
public String encode()
```
    Encode the list in semicolon separated form.
    
    Returns:
    an encoded string containing the objects in this list.
    Since:
    
    v1.0
  - encode
```
public StringBuilder encode(StringBuilder buffer)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - set
```
public void set(NameValue nv)
```
    Set a namevalue object in this list.
  - set
```
public void set(String name,
       Object value)
```
    Set a namevalue object in this list.
  - equals
```
public boolean equals(Object otherObject)
```
    Compare if two NameValue lists are equal.
    
    Specified by:
    
    equals in interface Map<String,NameValue>
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    otherObject - is the object to compare to.
    
    Returns:
    true if the two objects compare for equality.
  - getValue
```
public Object getValue(String name)
```
    Do a lookup on a given name and return value associated with it.
  - getValue
```
public Object getValue(String name,
              boolean stripQuotes)
```
    Do a lookup on a given name and return value associated with it.
  - getNameValue
```
public NameValue getNameValue(String name)
```
    Get the NameValue record given a name.
    
    Since:
    
    1.0
  - hasNameValue
```
public boolean hasNameValue(String name)
```
    Returns a boolean telling if this NameValueList has a record with this name
    
    Since:
    
    1.0
  - delete
```
public boolean delete(String name)
```
    Remove the element corresponding to this name.
    
    Since:
    
    1.0
  - clone
```
public Object clone()
```
    Overrides:
    
    clone in class Object
  - size
```
public int size()
```
    Return the size of the embedded map
    
    Specified by:
    
    size in interface Map<String,NameValue>
  - isEmpty
```
public boolean isEmpty()
```
    Return true if empty.
    
    Specified by:
    
    isEmpty in interface Map<String,NameValue>
  - iterator
```
public Iterator<NameValue> iterator()
```
    Return an iterator for the name-value pairs of this list.
    
    Returns:
    the iterator.
  - getNames
```
public Iterator<String> getNames()
```
    Get a list of parameter names.
    
    Returns:
    a list iterator that has the names of the parameters.
  - getParameter
```
public String getParameter(String name)
```
    Get the parameter as a String.
    
    Returns:
    the parameter as a string.
  - getParameter
```
public String getParameter(String name,
                  boolean stripQuotes)
```
    Get the parameter as a String.
    
    Returns:
    the parameter as a string.
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Map<String,NameValue>
  - containsKey
```
public boolean containsKey(Object key)
```
    Specified by:
    
    containsKey in interface Map<String,NameValue>
  - containsValue
```
public boolean containsValue(Object value)
```
    Specified by:
    
    containsValue in interface Map<String,NameValue>
  - entrySet
```
public Set<Map.Entry<String,NameValue>> entrySet()
```
    Specified by:
    
    entrySet in interface Map<String,NameValue>
  - get
```
public NameValue get(Object key)
```
    Specified by:
    
    get in interface Map<String,NameValue>
  - keySet
```
public Set<String> keySet()
```
    Specified by:
    
    keySet in interface Map<String,NameValue>
  - put
```
public NameValue put(String name,
            NameValue nameValue)
```
    Specified by:
    
    put in interface Map<String,NameValue>
  - putAll
```
public void putAll(Map<? extends String,? extends NameValue> map)
```
    Specified by:
    
    putAll in interface Map<String,NameValue>
  - remove
```
public NameValue remove(Object key)
```
    Specified by:
    
    remove in interface Map<String,NameValue>
  - values
```
public Collection<NameValue> values()
```
    Specified by:
    
    values in interface Map<String,NameValue>
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Map<String,NameValue>
    
    Overrides:
    
    hashCode in class Object
  - getMap
```
protected Map<String,NameValue> getMap()
```
    Returns:
    the hmap

Class NameValueList

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NameValueList

NameValueList

Method Detail

setSeparator

encode

encode

toString

set

set

equals

getValue

getValue

getNameValue

hasNameValue

delete

clone

size

isEmpty

iterator

getNames

getParameter

getParameter

clear

containsKey

containsValue

entrySet

get

keySet

put

putAll

remove

values

hashCode

getMap