Library: baliListsCollections

VSID.baliListsCollections

Bali Lists & Collections Lotusscript Library

Based on Apache Open Source Libraries:
		Lists & Collections Lotusscript Library - Copyright &copy; 2002 - 2052, Devin S. Olson 
		enhLogClass Lotusscript Library - Copyright &copy; 2002 - 2052, Devin S. Olson

Library Summary

Script Creator Devin Olson
Uses Libraries baliStrings, baliCoreUtils

Script Creator	Devin Olson
Uses Libraries	baliStrings, baliCoreUtils

Classes Summary

azlwKeyedValueCarrier	Base Class for KeyedValue Carriers
azlwListCarrier	Base Class for List Carriers
BooleanList	Wrapper for a List As Boolean object, with extended functionality through the various properties and methods.
CurrencyList	Wrapper for a List As Currency object, with extended functionality through the various properties and methods.
DateList	Wrapper for a List As NotesDateTime object, with extended functionality through the various properties and methods.
DoubleList	Wrapper for a List As Double object, with extended functionality through the various properties and methods.
IntegerList	Wrapper for a List As Integer object, with extended functionality through the various properties and methods.
IntegerPairList	Wrapper for a List As IntegerPair object, with extended functionality through the various properties and methods.
IntegerQueue	Queue implementation for Integers
IntegersCarrier	Carrier class for Integers
IntegerStack	Stack implementation for Integers
KeyedNotesDateTime	Carrier for a key / value pair, where the value is a NotesDateTime object.
KeyedString	Carrier for a key / value pair, where the value is a String object.
KeyedStringList	Wrapper for a List As KeyedString object, with extended functionality through the various properties and methods.
KeyedVariant	Carrier for a key / value pair, where the value is a Variant.
LongList	Wrapper for a List As Long object, with extended functionality through the various properties and methods.
SingleList	Wrapper for a List As Single object, with extended functionality through the various properties and methods.
StringList	Wrapper for a List As String object, with extended functionality through the various properties and methods.
StringQueue	Carrier class for Strings
StringsCarrier	Carrier class for Strings
StringsCarrierList	Wrapper for a List As StringsCarrier object, with extended functionality through the various properties and methods.
StringStack	Carrier class for Strings
VariantList	Wrapper for a List As Variant object, with extended functionality through the various properties and methods.

Method Summaries

`at_urlEncode(source As String) As String`
`getJSONelementTypeName(source As Integer) As String`
`getSortedListTags(source As Variant) As Variant`
`jsonArrayToJSON(source As NotesJSONArray) As String`
`StringToStringsCarrier(source As String) As StringsCarrier`
`toJSONvalue(source As Variant) As String`
`write_StringQueueToFile(source As StringQueue, target As String) As Long`

Methods Detail

at_urlEncode
Public Function at_urlEncode(source As String) As String
LotusScript implementation of @URLencode method

idx Argument Data Type Attributes Comments
1 source String

Public Function at_urlEncode(source As String) As String
LotusScript implementation of @URLencode method
idx	Argument	Data Type	Attributes	Comments
1	source	String

getJSONelementTypeName

Public Function getJSONelementTypeName(source As Integer) As String
Gets the appropriate name for a given JSON Element Type
idx	Argument	Data Type	Attributes	Comments
1	source	Integer		Integer value for a JSON Element type

Throws Exceptions
Message	Error Code	Comments
MSG_PARAMETER_INVALID	1195	if source% is not an appropriate JSON Element Type

getSortedListTags

Public Function getSortedListTags(source As Variant) As Variant
Gets the Sorted listTags for a list
idx	Argument	Data Type	Attributes	Comments
1	source	Variant		List object from which to get the list tags

jsonArrayToJSON

Public Function jsonArrayToJSON(source As NotesJSONArray) As String
Converts a NotesJSONArray to JSON Empty strings, null, zero, and false values are not included in the result.
idx	Argument	Data Type	Attributes	Comments
1	source	NotesJSONArray		NotesJSONArray from which to construct the JSON

StringToStringsCarrier

Public Function StringToStringsCarrier(source As String) As StringsCarrier
Generates a single-element StringsCarrier containing a given string
idx	Argument	Data Type	Attributes	Comments
1	source	String		String to be added to the new StringsCarrier

toJSONvalue
Public Function toJSONvalue(source As Variant) As String
idx Argument Data Type Attributes Comments
1 source Variant Converts a value to a JSON string representation.

Public Function toJSONvalue(source As Variant) As String
idx	Argument	Data Type	Attributes	Comments
1	source	Variant		Converts a value to a JSON string representation.

write_StringQueueToFile

Public Function write_StringQueueToFile(source As StringQueue, target As String) As Long
Writes content from a StringQueue to a text file, line by line, until the StringQueue contains no more content. THIS METHOD WILL EMPTY THE StringQueue IMPORTANT NOTE: Existing files will be OVERWRITTEN! It is up to the calling code to pre-check for existence of file.
idx	Argument	Data Type	Attributes	Comments
1	source	StringQueue		StringQueue whose content should be written to the file
2	target	String		Filepath of file to be written.

Throws Exceptions
Message	Error Code	Comments
MSG_PARAMETER_BLANK	1199	if the StringQueue is Nothing.
MSG_PARAMETER_BLANK	1199	if target filepath is blank.
MSG_OPERATION_FAILED	1000	or other file system exception on failure.

Library baliListsCollections

VSID.baliListsCollections

Library Summary

Classes Summary

Method Summaries

Methods Detail

at_urlEncode

getJSONelementTypeName

getSortedListTags

jsonArrayToJSON

StringToStringsCarrier

toJSONvalue

write_StringQueueToFile