FindNextItemNumber (Arraylist function) - Revision history

JAL: /* See also */

2012-11-01T15:40:05Z

JAL at 15:39, 1 November 2012

2012-11-01T15:39:46Z

← Older revision		Revision as of 15:39, 1 November 2012
Line 1:		Line 1:
	{{Template:Arraylist:FindNextItemNumber subtitle}}		{{Template:Arraylist:FindNextItemNumber subtitle}}
	<var>FindNextItemNumber</var> searches "forward" in the <var>Arraylist</var> to find and return the item number of the next item that matches a specified criterion. The criterion is supplied by the [[SelectionCriterion class\|SelectionCriterion]] object that is a required <var>FindNextItemNumber</var> parameter. If no item satisfies the criterion, the method returns a zero.		<var>FindNextItemNumber</var> searches "forward" in the <var>Arraylist</var> to find and return the item number of the next item that matches a specified criterion. The criterion is supplied by the <var>[[SelectionCriterion class\|SelectionCriterion]]</var> object that is a required <var>FindNextItemNumber</var> parameter. If no item satisfies the criterion, the method returns a zero.

	==Syntax==		==Syntax==
Line 27:		Line 27:
	<ul>		<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, <var>FindNextItemNumber</var> returns a zero.</li>		<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, <var>FindNextItemNumber</var> returns a zero.</li>

	<li><var>FindNextItemNumber</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6 and later.</li>		<li><var>FindNextItemNumber</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6 and later.</li>
	<li>If one is only looking for the first or only item that matches that selection criteria and one doesn't care about the item number of the matching item, [[FindNextItem (Arraylist function)\|FindNextItem]] might be a better method to use than <var>FindNextItemNumber</var>.
			<li>If one is only looking for the first or only item that matches that selection criteria and one doesn't care about the item number of the matching item, <var>[[FindNextItem (Arraylist function)\|FindNextItem]]</var> might be a better method to use than <var>FindNextItemNumber</var>.
	</ul>		</ul>

Line 53:		Line 55:

	==See also==		==See also==
	<ul><li>[[FindPreviousItemNumber (Arraylist function)\|FindPreviousItemNumber]] is identical to <var>FindNextItemNumber</var> except that it searches backward in the <var>Arraylist</var>.</ul>		<ul>
			<li>[[FindPreviousItemNumber (Arraylist function)\|FindPreviousItemNumber]] is identical to <var>FindNextItemNumber</var> except that it searches backward in the <var>Arraylist</var>.
			</ul>

	{{Template:Arraylist:FindNextItemNumber footer}}		{{Template:Arraylist:FindNextItemNumber footer}}

JAL2: /* Syntax terms */

2012-08-09T23:32:13Z

Syntax terms

← Older revision		Revision as of 23:32, 9 August 2012
Line 14:		Line 14:

	<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.<p>For example, <code>GT(this, -11)</code> is the criterion <code>this > -11</code>, where <code var ="term">this</code> is an identity function that simply returns the item's value. The first item tested by <var>FindNextItemNumber</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>		<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 <code var ="term">this</code> is an identity function that simply returns the item's value. The first item tested by <var>FindNextItemNumber</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>

	<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 Start 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 Start 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>

JAL2 at 21:15, 7 August 2012

2012-08-07T21:15:16Z

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

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%number</th>		<tr><th>%number</th>
	<td>A numeric variable to return the item number of the item that is located by the search. </td></tr>		<td>A numeric variable to return the item number of 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.<p>For example, <code>GT(this, -11)</code> is the criterion <code>this > -11</code>, where <code var ="term">this</code> is an identity function that simply returns the item's value. The first item tested by <var>FindNextItemNumber</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>		<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 <code var ="term">this</code> is an identity function that simply returns the item's value. The first item tested by <var>FindNextItemNumber</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>

	<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 Start 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 Start 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>

JAL2: /* Syntax terms */

2012-07-17T20:40:50Z

Syntax terms

← Older revision		Revision as of 20:40, 17 July 2012
Line 11:		Line 11:
	<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 ~~class="term"~~>[[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 <code var ="term">this</code> is an identity function that simply returns the item's value. The first item tested by <var>FindNextItemNumber</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>		<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 <code var ="term">this</code> is an identity function that simply returns the item's value. The first item tested by <var>FindNextItemNumber</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>
	<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 Start 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 Start 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>

JAL2: /* Examples */

2012-07-17T20:40:28Z

Examples

← Older revision		Revision as of 20:40, 17 July 2012
Line 24:		Line 24:

	==Examples==		==Examples==
	~~<ol><li>~~
	The following request contains two <var>FindNextItemNumber</var> calls, one with a simple selection criterion and one with a compound criterion:		The following request contains two <var>FindNextItemNumber</var> calls, one with a simple selection criterion and one with a compound criterion:
	<p class="code">begin		<p class="code">begin
Line 43:		Line 42:
	<p class="output">%al:findNextItemNumber(%sel1, start=1) is: 0		<p class="output">%al:findNextItemNumber(%sel1, start=1) is: 0
	%al:findNextItemNumber(%sel2) is: 5		%al:findNextItemNumber(%sel2) is: 5
	</p~~></ol~~>		</p>

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

Alex: /* Usage notes */

2012-01-01T21:45:58Z

Usage notes

← Older revision		Revision as of 21:45, 1 January 2012
Line 18:		Line 18:
	==Usage notes==		==Usage notes==
	<ul>		<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, <var>FindNextItemNumber</var> returns a zero.		<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, <var>FindNextItemNumber</var> returns a zero.</li>
	<li><var>FindNextItemNumber</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6 and later.		<li><var>FindNextItemNumber</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.6 and later.</li>
			<li>If one is only looking for the first or only item that matches that selection criteria and one doesn't care about the item number of the matching item, [[FindNextItem (Arraylist function)\|FindNextItem]] might be a better method to use than <var>FindNextItemNumber</var>.
	</ul>		</ul>

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 19:		Line 19:
	<ul>		<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, <var>FindNextItemNumber</var> returns a zero.		<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, <var>FindNextItemNumber</var> returns a zero.
	<li><var>FindNextItemNumber</var> is available in <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.6 and later.		<li><var>FindNextItemNumber</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)

← Older revision		Revision as of 15:40, 1 November 2012
Line 56:		Line 56:
	==See also==		==See also==
	<ul>		<ul>
	<li>[[FindPreviousItemNumber (Arraylist function)\|FindPreviousItemNumber]] is identical to <var>FindNextItemNumber</var> except that it searches backward in the <var>Arraylist</var>.		<li><var>[[FindPreviousItemNumber (Arraylist function)\|FindPreviousItemNumber]]</var> is identical to <var>FindNextItemNumber</var> except that it searches backward in the <var>Arraylist</var>.
	</ul>		</ul>

	{{Template:Arraylist:FindNextItemNumber footer}}		{{Template:Arraylist:FindNextItemNumber footer}}