FindNextItem (Arraylist function) - Revision history

JAL: /* Usage notes */

2013-02-20T16:18:50Z

Usage notes

← Older revision		Revision as of 16:18, 20 February 2013
Line 33:		Line 33:
	<li><var>FindNextItem</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6 and later.</li>		<li><var>FindNextItem</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6 and later.</li>

	<li>If ~~one wishes~~ to search through an Arraylist for multiple items or ~~one is~~ interested in the item number of the matching item, ~~one should probably~~ use <var>[[FindNextItemNumber (Arraylist function)\|FindNextItemNumber]]</var> instead of <var>FindNextItem</var>.		<li>If you want to search through an <var>Arraylist</var> for multiple items, or if you are interested in the item number of the matching item, use <var>[[FindNextItemNumber (Arraylist function)\|FindNextItemNumber]]</var> instead of <var>FindNextItem</var>.
	</ul>		</ul>

JAL at 15:37, 1 November 2012

2012-11-01T15:37:26Z

← Older revision		Revision as of 15:37, 1 November 2012
Line 16:		Line 16:
	<td>A <var>[[SelectionCriterion class\|selectionCriterion]]</var> object, which is a relational expression that is applied to an <var class="term">al</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.		<td>A <var>[[SelectionCriterion class\|selectionCriterion]]</var> object, which is a relational expression that is applied to an <var class="term">al</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>GT(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>FindNextItem</var> that satisfies this expression is the method's return value.</p>		<p>For example, <code>GT(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>FindNextItem</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">al</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>		<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">al</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><var>Start</var></th>		<tr><th><var>Start</var></th>
	<td>The <var class="term">number</var> of the item <b><i>after</i></b> which to begin the search. If the <var class="term">number</var> value of <var>Start</var> is 2, item 3 is the first item considered. The value of <var>Start</var> may be 0 through the number of items in the collection. For a collection of three items, <var class="term">number</var> may be 0, 1, 2, or 3.<p>The default value for <var>Start</var> is <code>0</code>; to start from the first item in <var class="term">al</var>.</p><p>This is an optional, but ~~<var>~~[[~~Methods~~#Named parameters\|~~NameRequired~~]]~~</var>~~, argument; if you specify a value, the parameter name <var>Start</var> is required.</p></td></tr>		<td>The <var class="term">number</var> of the item <b><i>after</i></b> which to begin the search. If the <var class="term">number</var> value of <var>Start</var> is 2, item 3 is the first item considered. The value of <var>Start</var> may be 0 through the number of items in the collection. For a collection of three items, <var class="term">number</var> may be 0, 1, 2, or 3.
			<p>
			The default value for <var>Start</var> is <code>0</code>; to start from the first item in <var class="term">al</var>.</p>
			<p>
			This is an optional, but [[Notation conventions for methods#Named parameters\|name required]], argument; if you specify a value, the parameter name <var>Start</var> is required.</p></td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul><li>If the value of <var>Start</var> is greater than the number of items in the <var>Arraylist</var>, the request is cancelled. If the value of <var>Start</var> is equal to the number of items, the request is cancelled, but an <var>[[ItemNotFound class\|ItemNotFound]]</var> exception is thrown.</li>		<ul>
			<li>If the value of <var>Start</var> is greater than the number of items in the <var>Arraylist</var>, the request is cancelled. If the value of <var>Start</var> is equal to the number of items, the request is cancelled, but an <var>[[ItemNotFound class\|ItemNotFound]]</var> exception is thrown.</li>

	<li><var>FindNextItem</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6 and later.</li>		<li><var>FindNextItem</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6 and later.</li>
	<li>If one wishes to search through an Arraylist for multiple items or one is interested in the item number of the matching item, one should probably use [[FindNextItemNumber (Arraylist function)\|FindNextItemNumber]] instead of <var>FindNextItem</var>.
			<li>If one wishes to search through an Arraylist for multiple items or one is interested in the item number of the matching item, one should probably use <var>[[FindNextItemNumber (Arraylist function)\|FindNextItemNumber]]</var> instead of <var>FindNextItem</var>.
	</ul>		</ul>

JAL2 at 21:13, 7 August 2012

2012-08-07T21:13:07Z

← Older revision		Revision as of 21:13, 7 August 2012
Line 4:		Line 4:
	==Syntax==		==Syntax==
	{{Template:Arraylist:FindNextItem syntax}}		{{Template:Arraylist:FindNextItem syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%item</th>		<tr><th>%item</th>
	<td>A variable of the type of the items in the <var>Arraylist</var> to contain the item that is located by the search. </td></tr>		<td>A variable of the type of the items in the <var>Arraylist</var> to contain the item that is located by the search. </td></tr>

	<tr><th>al</th>		<tr><th>al</th>
	<td>An <var>Arraylist</var> object.</td></tr>		<td>An <var>Arraylist</var> object.</td></tr>

	<tr><th>selectionCriterion</th>		<tr><th>selectionCriterion</th>
	<td>A <var>[[SelectionCriterion class\|selectionCriterion]]</var> object, which is a relational expression that is applied to an <var class="term">al</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.		<td>A <var>[[SelectionCriterion class\|selectionCriterion]]</var> object, which is a relational expression that is applied to an <var class="term">al</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>GT(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>FindNextItem</var> that satisfies this expression is the method's return value.</p>		<p>For example, <code>GT(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>FindNextItem</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">al</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>		<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">al</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><var>Start</var></th>		<tr><th><var>Start</var></th>
	<td>The <var class="term">number</var> of the item <b><i>after</i></b> which to begin the search. If the <var class="term">number</var> value of <var ~~class="term"~~>Start</var> is 2, item 3 is the first item considered. The value of <var ~~class="term"~~>Start</var> may be 0 through the number of items in the collection. For a collection of three items, <var class="term">number</var> may be 0, 1, 2, or 3.<p>The default value for <var>Start</var> is <code>0</code>; to start from the first item in <var class="term">al</var>.</p><p>This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var ~~class="term"~~>Start</var> is required.</p></td></tr>		<td>The <var class="term">number</var> of the item <b><i>after</i></b> which to begin the search. If the <var class="term">number</var> value of <var>Start</var> is 2, item 3 is the first item considered. The value of <var>Start</var> may be 0 through the number of items in the collection. For a collection of three items, <var class="term">number</var> may be 0, 1, 2, or 3.<p>The default value for <var>Start</var> is <code>0</code>; to start from the first item in <var class="term">al</var>.</p><p>This is an optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, argument; if you specify a value, the parameter name <var>Start</var> is required.</p></td></tr>
	</table>		</table>

Dme: /* Usage notes */

2012-04-04T20:56:05Z

Usage notes

← Older revision		Revision as of 20:56, 4 April 2012
Line 19:		Line 19:

	==Usage notes==		==Usage notes==
	<ul><li>If the value of <var ~~class="term"~~>Start</var> is greater than the number of items in the <var>Arraylist</var>, the request is cancelled. If the value of <var ~~class="term"~~>Start</var> is equal to the number of items, the request is cancelled, but an <var>[[ItemNotFound class\|ItemNotFound]]</var> exception is thrown.</li>		<ul><li>If the value of <var>Start</var> is greater than the number of items in the <var>Arraylist</var>, the request is cancelled. If the value of <var>Start</var> is equal to the number of items, the request is cancelled, but an <var>[[ItemNotFound class\|ItemNotFound]]</var> exception is thrown.</li>
	<li><var>FindNextItem</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6 and later.</li>		<li><var>FindNextItem</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6 and later.</li>
	<li>If one wishes to search through an Arraylist for multiple items or one is interested in the item number of the matching item, one should probably use [[FindNextItemNumber (Arraylist function)\|FindNextItemNumber]] instead of <var>FindNextItem</var>.		<li>If one wishes to search through an Arraylist for multiple items or one is interested in the item number of the matching item, one should probably use [[FindNextItemNumber (Arraylist function)\|FindNextItemNumber]] instead of <var>FindNextItem</var>.

Alex: /* Usage notes */

2012-01-01T21:48:34Z

Usage notes

← Older revision		Revision as of 21:48, 1 January 2012
Line 19:		Line 19:

	==Usage notes==		==Usage notes==
	<ul><li>If the value of <var class="term">Start</var> is greater than the number of items in the <var>Arraylist</var>, the request is cancelled. If the value of <var class="term">Start</var> is equal to the number of items, the request is cancelled, but an <var>[[ItemNotFound class\|ItemNotFound]]</var> exception is thrown.		<ul><li>If the value of <var class="term">Start</var> is greater than the number of items in the <var>Arraylist</var>, the request is cancelled. If the value of <var class="term">Start</var> is equal to the number of items, the request is cancelled, but an <var>[[ItemNotFound class\|ItemNotFound]]</var> exception is thrown.</li>
	<li><var>FindNextItem</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6 and later.		<li><var>FindNextItem</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6 and later.</li>
			<li>If one wishes to search through an Arraylist for multiple items or one is interested in the item number of the matching item, one should probably use [[FindNextItemNumber (Arraylist function)\|FindNextItemNumber]] instead of <var>FindNextItem</var>.
	</ul>		</ul>

JAL2: /* Examples */

2011-08-08T23:07:28Z

Examples

← Older revision		Revision as of 23:07, 8 August 2011
Line 29:		Line 29:
	%al = list(111, 29, 0, 93, 77, -345)		%al = list(111, 29, 0, 93, 77, -345)

	%sel1 is object ~~<var>~~[[SelectionCriterion class\|~~SelectionCriterion~~]]~~</var>~~ for float		%sel1 is object [[SelectionCriterion class\|selectioncriterion]] for float
	%sel2 is object selectioncriterion for float		%sel2 is object selectioncriterion for float
	%sel1 = GT(this, 0)		%sel1 = GT(this, 0)

JAL2: /* Examples */

2011-08-08T23:04:29Z

Examples

← Older revision		Revision as of 23:04, 8 August 2011
Line 24:		Line 24:

	==Examples==		==Examples==
	~~<ol>~~		The following request contains three <var>FindNextItem</var> calls, two with a simple selection criterion and one with a compound criterion. The second <var>FindNextItem</var> call fails, but a Try clause catches the exception and issues a third <var>FindNextItem</var> call:
	~~<li>~~The following request contains three <var>FindNextItem</var> calls, two with a simple selection criterion and one with a compound criterion. The second <var>FindNextItem</var> call fails, but a Try clause catches the exception and issues a third <var>FindNextItem</var> call:
	<p class="code">begin		<p class="code">begin
	%al is arraylist of float		%al is arraylist of float
Line 53:		Line 52:
	%al:findNextItem(%sel2) is: 77		%al:findNextItem(%sel2) is: 77
	</p>		</p>
	~~</ol>~~

	==See also==		==See also==
	<ul><li><var>[[FindPreviousItem (Arraylist function)\|FindPreviousItem]]</var> is identical to <var>FindNextItem</var> except that it searches backward in the <var>Arraylist</var>.</ul>		<ul><li><var>[[FindPreviousItem (Arraylist function)\|FindPreviousItem]]</var> is identical to <var>FindNextItem</var> except that it searches backward in the <var>Arraylist</var>.</ul>
	{{Template:Arraylist:FindNextItem footer}}		{{Template:Arraylist:FindNextItem footer}}

JALWiccan: 1 revision

2011-05-04T17:45:55Z

1 revision

← Older revision	Revision as of 17:45, 4 May 2011
(No difference)

JALWiccan: 1 revision

2011-05-04T17:45:54Z

1 revision

← Older revision		Revision as of 17:45, 4 May 2011
Line 20:		Line 20:
	==Usage notes==		==Usage notes==
	<ul><li>If the value of <var class="term">Start</var> is greater than the number of items in the <var>Arraylist</var>, the request is cancelled. If the value of <var class="term">Start</var> is equal to the number of items, the request is cancelled, but an <var>[[ItemNotFound class\|ItemNotFound]]</var> exception is thrown.		<ul><li>If the value of <var class="term">Start</var> is greater than the number of items in the <var>Arraylist</var>, the request is cancelled. If the value of <var class="term">Start</var> is equal to the number of items, the request is cancelled, but an <var>[[ItemNotFound class\|ItemNotFound]]</var> exception is thrown.
	<li><var>FindNextItem</var> is available in <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.6 and later.		<li><var>FindNextItem</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6 and later.
	</ul>		</ul>

JALWiccan: 1 revision

2011-04-12T23:49:53Z

1 revision

← Older revision	Revision as of 23:49, 12 April 2011
(No difference)