PersistentObjectInfo class

From m204wiki
Jump to navigation Jump to search

The PersistentObjectInfo class contains information about a global or session object in the current thread (note that global and session objects are different from Persistent variables).

PersistentObjectInfo objects offer the advantage of the sorting, finding, and subsetting facilities of collections.

The PersistentObjectInfo class is available as of Sirius Mods Version 7.8.

The information accessing methods

Three pieces of information (provided by class functions named as follows) are available for a global or session object in the PersistentObjectInfo class:

Name The global/session name associated with the object.
SetTime The time the global/session object was set (YYYYMMDDHHMISSXXX format).
ClassDescription A description of the class of the object. For example, "System:Stringlist", or "MyUserLanguageClass", or "Arraylist of Object MyUserLanguageClass".

SetTime and ClassDescription are intended for debugging and problem diagnosis and not for application purposes:

  • For Global/Session variable declarations, SetTime does not change if request A sets a variable to an object instance, and then request B sets it to a new value, SetTime still indicates the time the object reference was set in request A.
  • The format of the data in ClassDescription is subject to change by Rocket; for example, a change in casing.

Creating PersistentObjectInfo objects

Using NewFromGlobal or NewFromSession

One way of creating a PersistentObjectInfo object is with the NewFromGlobal method or the NewFromSession method. These methods take a single, required, unnamed string parameter that indicates the name of the global or session variable:

%persInfo is object persistentObjectInfo ... %persInfo = newFromGlobal('FOOBAR') printText *** {~} = {%persInfo:name}, {~} = {%persInfo:setTime}, {~} = {%persInfo:classDescription} ... %persInfo = newFromSession('SNAFU') printText *** {~} = {%persInfo:name}, {~} = {%persInfo:setTime}, {~} = {%persInfo:classDescription}

A NewFromSession request cancels if not in a session.

Using GlobalList or SessionList

Probably the most common way of creating PersistentObjectInfo objects is using the GlobalList and SessionList methods. These are shared methods that return an Arraylist of Object PersistentObjectInfo.

The GlobalList and SessionList methods have one optional parameter that contains the name of the variables to be returned, with wildcards allowed. These wildcards are the User Language standard, non-regex, wildcards. Specifying no variable name is the same as specifying an asterisk (*) for the variable name: the information is returned for all global or session objects.

For example:

%persInfoList is arraylist of object persistentObjectInfo ... %persInfoList = %(persistentObjectInfo):globalList for %i from 1 to %persInfoList:count printText *** {~} = {%i}, {~} = {%persInfoList(%i):name}, {~} = {%persInfoList(%i):classDescription} end for

The PersistentObjectInfoList type

As a coding convenience, the PersistentObjectInfoList type is defined as an "Arraylist of Object PersistentObjectInfo". Consequently, you can specify a declaration like the one in the preceding example for %persInfoList more simply as:

%persInfoList is type persistentObjectInfoList

Note: The keyword Type is required.

The GlobalList and SessionList Object class methods

The GlobalList and SessionList methods are members of two classes. In addition to belonging to the PersistentObjectInfo class, they are also Object class shared methods. This means that both of these statements are valid:

%persInfoList = %(persistentObjectInfo):globalList %persInfoList = %(object):globalList

And a statement like the following is also valid:

%persInfoList = %(object):globalList:sortNew(descending(setTime))

List of PersistentObjectInfo methods

The List of PersistentObjectInfo methods contains a complete list of the class methods.