com.businessobjects.sdk.plugin.desktop.common
Interface INameValuePairs

public interface INameValuePairs

This interface provides access to a collection of name-value pairs.

Method Summary

boolean	add(java.lang.String name, java.lang.String value) Adds a name-value pair to the collection.
java.util.Map	getMap() Returns this name-value collection as a Map.
java.lang.String	getValue(java.lang.String name) Returns the value for the specified entry in the collection.
boolean	remove(java.lang.String name) Removes the name-value pair with the name from the collection.
boolean	update(java.lang.String name, java.lang.String value) Updates the value associated with the specified name.

Method Detail

add

boolean add(java.lang.String name,
            java.lang.String value)

Adds a name-value pair to the collection.

Parameters:

name - the name

value - the value

Returns:

true if the name-value pair is added successfully, false otherwise.

getMap

java.util.Map getMap()

Returns this name-value collection as a Map.

Returns:

A Map containing the name-value pairs.

update

boolean update(java.lang.String name,
               java.lang.String value)

Updates the value associated with the specified name. If there is no value corresponding to the specified name, this method has the same behavior as INameValuePairs.add(String, String).

Parameters:

name - the name of a name-value pair within this collection

value - the new value for the name-value pair

Returns:

true if the entry is updated successfully, false otherwise.

remove

boolean remove(java.lang.String name)

Removes the name-value pair with the name from the collection.

Parameters:

name - the name of a name-value pair within this collection

Returns:

true if the name-value pair is removed successfully, false otherwise.

getValue

java.lang.String getValue(java.lang.String name)

Returns the value for the specified entry in the collection.

Parameters:

name - the name of a name-value pair within this collection

Returns:

The value of the name-value pair.