: Class IVariantDictionary

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

jasp.buildin
Class IVariantDictionary

java.lang.Object
  |
  +--jasp.buildin.IVariantDictionary

public class IVariantDictionary
extends java.lang.Object

This class is a general interface wrapper that can wrap the following collections:

Session.StaticObjects
Session.Contents
Application.StaticObjects
Application.Contents

Constructor Summary

IVariantDictionary()
          Creates the IVariantDictionary object.

Method Summary

java.util.Enumeration elements()
          Retrieves an enumerator interface which can be used to iterate through the items in the collection.

int getCount()
          Returns the number of items in either the Contents or StaticObjects collection.

variant getItem(int index)
          Retrieves the specified item from either the Contents or StaticObjects colleciton.

variant getItem(java.lang.String key)
          Retrieves the specified item from either the Contents or StaticObjects colleciton.

java.lang.String getKey(int index)
          Returns a unique identifier for an item in either the Contents or StaticObjects collection.

void Remove(int index)
          Deletes an item from the Contents collection.

void Remove(java.lang.String key)
          Deletes an item from the Contents collection.

void RemoveAll()
          Deletes all items from the Contents Collection.

void setItem(java.lang.String key, boolean value)
          Adds an item to either the Contents or StaticObjects collection

void setItem(java.lang.String key, double value)
          Adds an item to either the Contents or StaticObjects collection

void setItem(java.lang.String key, int value)
          Adds an item to either the Contents or StaticObjects collection

void setItem(java.lang.String key, java.lang.Object value)
          Adds an item to either the Contents or StaticObjects collection

void setItem(java.lang.String key, java.lang.String value)
          Adds an item to either the Contents or StaticObjects collection

Methods inherited from class java.lang.Object

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

Constructor Detail

IVariantDictionary

public IVariantDictionary()

Creates the IVariantDictionary object.

Method Detail

getKey

public java.lang.String getKey(int index)

Returns a unique identifier for an item in either the Contents or StaticObjects collection.

Parameters:: index - the item index in the collection.
Returns:: the name of the item.

elements

public java.util.Enumeration elements()

Retrieves an enumerator interface which can be used to iterate through the items in the collection.

Returns:: an enumeration.

getItem

public variant getItem(int index)

Retrieves the specified item from either the Contents or StaticObjects colleciton.

Parameters:: index - the item index.
Returns:: the value of the item.

getItem

public variant getItem(java.lang.String key)

Retrieves the specified item from either the Contents or StaticObjects colleciton.

Parameters:: key - the name of the item.
Returns:: the value of the item.