net.rim.device.api.system
Class CodeModuleGroupManager

java.lang.Object
  net.rim.device.api.system.CodeModuleGroupManager

public class CodeModuleGroupManager
extends Object

Code module group management functionality

Code module groups provide a way for the device to store meta-information associated with groups of modules (for example, all the modules that make up a single application). The device stores code module group data in serialized form in a persisted store in the file system. Access to this store is moderated by the code module group manager system singleton.

Users of the code module group manager can identify modules in two ways: by name (string value), and by handle (integer value).

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.2.1

Method Summary
	static int	getNumberOfGroups() Retrieves the current number of code module groups.
	static CodeModuleGroup	load(String groupName) Loads code module group by name.
	static CodeModuleGroup[]	loadAll() Retrieves all known code module group data blocks into an array of CodeModuleGroup instances.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

load

public static CodeModuleGroup load(String groupName)

Loads code module group by name.

Invoke this method to load the data for a named code module group into a CodeModuleGroup instance and then retrieve the object.

Parameters:

groupName - Name of group to load; must not be null or longer than 256 characters.

Returns:

Named group or null, if no such group exists or is loadable.

Throws:

IllegalArgumentException - If you provide a group name that's too long.

NullPointerException - If you provide a null group name.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.2.1

loadAll

public static CodeModuleGroup[] loadAll()

Retrieves all known code module group data blocks into an array of CodeModuleGroup instances.

Returns:

All known code module groups; may be null if no code module groups known at the moment.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.2.1

getNumberOfGroups

public static int getNumberOfGroups()

Retrieves the current number of code module groups.

Returns:

Number of code module groups the device has in its store of group data blocks.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.2.1