gov.cca.TypeMap Interface Reference

A CCA map. More...

List of all members.

Public Member Functions

TypeMap cloneTypeMap ()
 Create an exact copy of this Map.
TypeMap cloneEmpty ()
 Create a new Map with no key/value associations.
int getInt (in string key, in int dflt) throws TypeMismatchException
long getLong (in string key, in long dflt) throws TypeMismatchException
float getFloat (in string key, in float dflt) throws TypeMismatchException
double getDouble (in string key, in double dflt) throws TypeMismatchException
fcomplex getFcomplex (in string key, in fcomplex dflt) throws TypeMismatchException
dcomplex getDcomplex (in string key, in dcomplex dflt) throws TypeMismatchException
string getString (in string key, in string dflt) throws TypeMismatchException
bool getBool (in string key, in bool dflt) throws TypeMismatchException
array< int > getIntArray (in string key, in array< int > dflt) throws TypeMismatchException
array< long > getLongArray (in string key, in array< long > dflt) throws TypeMismatchException
array< float > getFloatArray (in string key, in array< float > dflt) throws TypeMismatchException
array< double > getDoubleArray (in string key, in array< double > dflt) throws TypeMismatchException
array< fcomplex > getFcomplexArray (in string key, in array< fcomplex > dflt) throws TypeMismatchException
array< dcomplex > getDcomplexArray (in string key, in array< dcomplex > dflt) throws TypeMismatchException
array< string > getStringArray (in string key, in array< string > dflt) throws TypeMismatchException
array< bool > getBoolArray (in string key, in array< bool > dflt) throws TypeMismatchException
void putInt (in string key, in int value) throws TypeMismatchException
 Assign a key and value.
void putLong (in string key, in long value) throws TypeMismatchException
void putFloat (in string key, in float value) throws TypeMismatchException
void putDouble (in string key, in double value) throws TypeMismatchException
void putFcomplex (in string key, in fcomplex value) throws TypeMismatchException
void putDcomplex (in string key, in dcomplex value) throws TypeMismatchException
void putString (in string key, in string value) throws TypeMismatchException
void putBool (in string key, in bool value) throws TypeMismatchException
void putIntArray (in string key, in array< int > value) throws TypeMismatchException
void putLongArray (in string key, in array< long > value) throws TypeMismatchException
void putFloatArray (in string key, in array< float > value) throws TypeMismatchException
void putDoubleArray (in string key, in array< double > value) throws TypeMismatchException
void putFcomplexArray (in string key, in array< fcomplex > value) throws TypeMismatchException
void putDcomplexArray (in string key, in array< dcomplex > value) throws TypeMismatchException
void putStringArray (in string key, in array< string > value) throws TypeMismatchException
void putBoolArray (in string key, in array< bool > value) throws TypeMismatchException
void remove (in string key)
 Make the key and associated value disappear from the object.
array< string > getAllKeys (in Type t)
 Get all the names associated with a particular type without exposing the data implementation details.
bool hasKey (in string key)
 Return true if the key exists in this map.
Type typeOf (in string key)
 Return the type of the value associated with this key.


Detailed Description

A CCA map.

Maps a string key to a particular value. Types are strictly enforced. For example, values places into the map using putInt can be retrieved only using getInt. Calls to getLong, getString, getIntArray and other get methods will fail (i.e. return the default value).


Member Function Documentation

TypeMap gov.cca.TypeMap.cloneEmpty (  ) 

Create a new Map with no key/value associations.

array< string > gov.cca.TypeMap.getAllKeys ( in Type  t  ) 

Get all the names associated with a particular type without exposing the data implementation details.

The keys will be returned in an arbitrary order. If type specified is NoType (no specification) all keys of all types are returned.

void gov.cca.TypeMap.putInt ( in string  key,
in int  value 
) throws TypeMismatchException

Assign a key and value.

Any value previously assigned to the same key will be overwritten so long as it is of the same type. If types conflict, an exception occurs.

void gov.cca.TypeMap.remove ( in string  key  ) 

Make the key and associated value disappear from the object.


The documentation for this interface was generated from the following file:

Generated on Mon Sep 14 18:29:47 2009 for cca-spec-babel by  doxygen 1.5.9