2.3.7 The HashMap Class

HashMap Class Overview

Parent class

Object

Child classes

None.

Methods

The following table lists the public methods of the HashMap class and the purpose or use of each method:

Table 2.22 HashMap class methods and descriptions

Name	Description
`HashMap()`	Class constructor
`~HashMap()`	Class destructor
`setName()`	Set a name for the hashmap
`getName()`	Gets a hashmap's name
`setMap()`	Sets a hashmap's length and values
`getMapLen()`	Gets a hashmap's length
`getMapValues()`	Gets the values contained in the hashmap
`equal()`	Compares this hashmap's values with those of another hashmap
`getObjectStatus()`	Gets the hashmap's object status
`getObjectVersion()`	Gets the hashmap's schema object version
`getObjectId()`	Gets the hashmap's ID

Types

The HashMap class defines no public types.

HashMap Constructor

Description

The HashMap class constructor normally requires no arguments. A copy constructor is also available.

See also Dictionary::createHashMap(), for more information.

Signature

Base constructor:

HashMap HashMap
    (
      void
    )

Copy constructor:

HashMap HashMap
    (
      const HashMap& hashmap
    )

Destructor:

virtual ~HashMap
    (
      void
    )

Parameters

None, or the address of an existing HashMap object to be copied.

Return value

A new instance of HashMap, possibly a copy of an existing one.

HashMap::setName()

Description

Sets the name of the hash map.

Signature

void setName
    (
      const char* name
    )

Parameters

The name to be assigned to the hashmap.

Return value

None.

HashMap::getName()

Description

Gets the name of the hash map.

Signature

const char* getName
    (
      void
    ) const

Parameters

None.

Return value

The name of the hash map.

HashMap::setMap()

Description

Assigns a set of values to a has map.

Signature

void setMap
    (
      const Uint32* values,
      Uint32 len
    )

Parameters

A pointer to a set of values of length len.

Return value

None.

HashMap::getMapLen()

Description

Gets the hash map's length; that is, the number of values which it contains. You can obtain the values using getMapValues().

Signature

Uint32 getMapLen
    (
      void
    ) const

Parameters

None.

Return value

The length of the hash map.

HashMap::getMapValues()

Description

Gets the values listed in the hash map.

Signature

int getMapValues
    (
      Uint32* dst,
      Uint32 len
    ) const

Parameters

A pointer to a set of values (dst) and the number of values (len).

Return value

Returns 0 on success; on failure, returns -1 and sets error.

HashMap::equal()

Description

Compares (only) the values of this HashMap with those of another one.

Signature

bool equal
    (
      const HashMap& hashmap
    ) const

Parameters

A reference to the hash map to be compared with this one.

Return value

None.

HashMap::getObjectStatus()

Description

This method retrieves the status of the HashMap for which it is invoked. The return value is of type Object::Status.

Signature

virtual Status getObjectStatus
    (
      void
    ) const

Parameters

None.

Return value

Returns the current Status of the HashMap.

HashMap::getObjectVersion()

Description

The method gets the hash map's schema object version.

Signature

virtual int getObjectVersion
    (
      void
    ) const

Parameters

None.

Return value

The object's version number, an integer.

HashMap::getObjectId()

Description

This method retrieves the hash map's ID.

Signature

virtual int getObjectId
    (
      void
    ) const

Parameters

None.

Return value

The object ID, an integer.