FindPreviousItem (GenericNamedArraylist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (→Examples) |
||
| (26 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:GenericNamedArraylist:FindPreviousItem subtitle}} | {{Template:GenericNamedArraylist:FindPreviousItem subtitle}} | ||
<var>findPreviousItem</var> searches "backward" in a <var>[[FloatNamedArraylist class|FloatNamedArraylist]]</var>, <var>[[NamedArraylist class|NamedArraylist]]</var>, or <var>[[UnicodeNamedArraylist class|UnicodeNamedArraylist]]</var> to find and return the previous item that matches a specified criterion. The criterion is supplied by the <var>[[SelectionCriterion class|SelectionCriterion]]</var> object | |||
the | that is a required <var>FindPreviousItem</var> parameter. If no item satisfies the criterion, the request is cancelled and an <var>[[ItemNotFound_class|ItemNotFound]]</var> exception is thrown. | ||
The criterion is supplied by the [[SelectionCriterion class|SelectionCriterion]] object | |||
that is a required FindPreviousItem parameter. | |||
If no item satisfies the criterion, | |||
the request is cancelled and an | |||
is thrown. | |||
==Syntax== | ==Syntax== | ||
{{Template:GenericNamedArraylist:FindPreviousItem syntax}} | {{Template:GenericNamedArraylist:FindPreviousItem syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th | <tr><th>%item</th> | ||
<td>A variable of the type | <td>A variable of the same item type as in the <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> to contain the item that is located by the search. </td></tr> | ||
<tr><th | <tr><th>%anyNal</th> | ||
<td>A NamedArraylist object. </td></tr> | <td>A <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var> object. </td></tr> | ||
<tr><th> | <tr><th>selectionCriterion</th> | ||
<td>A SelectionCriterion object, which is a relational expression that is applied to a | <td>A SelectionCriterion object, which is a relational expression that is applied to a <var class="term">anyNal</var> item value to determine whether the value satisfies the expression. The expression consists of a function, an operator, and a numeric or string value. | ||
<p>For example, <code>LT(this, -11)</code> is the criterion <code>this < -11</code>, where <var class="term">this</var> is an identity function that simply returns the item's value. The first item tested by <var>FindPreviousItem</var> that satisfies this expression is the method's return value.</p> | |||
<p>The function in the criterion is a method value (a method or class member name literal, or a method variable) for a method that operates on items of the type specified on the <var class="term">anyNal</var> declaration and that returns a numeric or string value. This is described further in [[SelectionCriterion class#Specifying a SelectionCriterion's parameters|"Specifying a SelectionCriterion's parameters"]].</p></td></tr> | |||
<tr><th>< | <tr><th><var>Start</var></th> | ||
<td>The number of the item | <td>The <var class="term">number</var> of the item <b><i>before</i></b> which to begin the search. If the value of <var>Start</var> is 4, item 3 is the first item considered. The value of <var>Start</var> may be 1 through one plus the number of items in the <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var>. For a collection of three items, <var>Start</var> may be 1, 2, 3, or 4. | ||
<p>This is an optional, [[Methods#Named parameters|name required]], argument which defaults to one plus the number of items in the collection. If you specify a value, the parameter name <var>Start</var> is required.</p></td></tr> | |||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>If the value of Start is not in the range of 1 through one plus the number | <li>If the value of <var>Start</var> is not in the range of 1 through one plus the number of items in the <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var>, the request is cancelled. If the value of <var>Start</var> is 1, no item can be found and the request is cancelled, but an <var>[[ItemNotFound_class|ItemNotFound]]</var> exception is thrown. | ||
of items in the NamedArraylist, the request is cancelled. | <li><var>FindPreviousItem</var> is available as of <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.6 and later. | ||
If the value of Start is 1, no item can be found and | |||
the request is cancelled, but an ItemNotFound exception is thrown. | |||
<li> | |||
</ul> | </ul> | ||
==Examples== | ==Examples== | ||
See the <var>FindNextItem</var> [[FindNextItem (GenericNamedArraylist function)#Examples|"Examples"]] section. | |||
==See also== | ==See also== | ||
<ul><li>The <var>[[FindNextItem_(GenericNamedArraylist_function)|FindNextItem]]</var> function is identical to <var>FindPreviousItem</var> except that it searches forward in the <var>FloatNamedArraylist</var>, <var>NamedArraylist</var>, or <var>UnicodeNamedArraylist</var>.</ul> | |||
{{Template:GenericNamedArraylist:FindPreviousItem footer}} | {{Template:GenericNamedArraylist:FindPreviousItem footer}} | ||
Latest revision as of 19:46, 1 November 2012
Previous item that matches some selection criteria (FloatNamedArraylist, NamedArraylist, and UnicodeNamedArraylist classes)
findPreviousItem searches "backward" in a FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist to find and return the previous item that matches a specified criterion. The criterion is supplied by the SelectionCriterion object
that is a required FindPreviousItem parameter. If no item satisfies the criterion, the request is cancelled and an ItemNotFound exception is thrown.
Syntax
%item = anyNal:FindPreviousItem( selectionCriterion, [Start= number]) Throws ItemNotFound
Syntax terms
| %item | A variable of the same item type as in the FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist to contain the item that is located by the search. |
|---|---|
| %anyNal | A FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist object. |
| selectionCriterion | A SelectionCriterion object, which is a relational expression that is applied to a anyNal item value to determine whether the value satisfies the expression. The expression consists of a function, an operator, and a numeric or string value.
For example, The function in the criterion is a method value (a method or class member name literal, or a method variable) for a method that operates on items of the type specified on the anyNal declaration and that returns a numeric or string value. This is described further in "Specifying a SelectionCriterion's parameters". |
| Start | The number of the item before which to begin the search. If the value of Start is 4, item 3 is the first item considered. The value of Start may be 1 through one plus the number of items in the FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist. For a collection of three items, Start may be 1, 2, 3, or 4.
This is an optional, name required, argument which defaults to one plus the number of items in the collection. If you specify a value, the parameter name Start is required. |
Usage notes
- If the value of Start is not in the range of 1 through one plus the number of items in the FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist, the request is cancelled. If the value of Start is 1, no item can be found and the request is cancelled, but an ItemNotFound exception is thrown.
- FindPreviousItem is available as of Sirius Mods Version 7.6 and later.
Examples
See the FindNextItem "Examples" section.
See also
- The FindNextItem function is identical to FindPreviousItem except that it searches forward in the FloatNamedArraylist, NamedArraylist, or UnicodeNamedArraylist.