@@ -127,15 +127,19 @@ it is to convert that DbObject to and from a JavaScript object.
127
127
128
128
.. method :: dbObject.append(value)
129
129
130
- Adds the given value to the end of the collection.
130
+ Adds the given value to the end of the collection. If no elements exist
131
+ in the collection, this creates an element at index 0. Otherwise, it
132
+ creates an element at the index position immediately following the highest
133
+ index available in the collection.
131
134
132
135
.. method :: dbObject.deleteElement(Number index)
133
136
134
137
Deletes the value from collection at the given index.
135
138
136
139
.. method :: dbObject.getElement(Number index)
137
140
138
- Returns the value associated with the given index.
141
+ Returns the value associated with the given index. If no element exists at
142
+ that index, an exception is raised.
139
143
140
144
.. method :: dbObject.getFirstIndex()
141
145
@@ -151,7 +155,9 @@ it is to convert that DbObject to and from a JavaScript object.
151
155
152
156
.. method :: dbObject.getNextIndex(Number index)
153
157
154
- Returns the next index value for later use to obtain a value.
158
+ Returns the next index value for later use to obtain a value. If there
159
+ are no elements in the collection following the specified index, it
160
+ returns *undefined *.
155
161
156
162
If the passed-in ``index `` parameter is not found in the :ref: `associative
157
163
array collection types indexed by integers <indexbyplsinteger>`, then this
@@ -160,7 +166,9 @@ it is to convert that DbObject to and from a JavaScript object.
160
166
161
167
.. method :: dbObject.getPrevIndex(Number index)
162
168
163
- Returns the previous index for later use to obtain the value.
169
+ Returns the previous index for later use to obtain the value. If there
170
+ are no elements in the collection preceding the specified index, it
171
+ returns *undefined *.
164
172
165
173
If the passed-in ``index `` parameter is not found in the :ref: `associative
166
174
array collection types indexed by integers <indexbyplsinteger>`, then this
0 commit comments