NotAtEnd (StringTokenizer function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 12: Line 12:
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%bool</th>
<tr><th>%bool</th>
<td>An enumeration object of type Boolean to contain the returned value of NotAtEnd.
<td>An enumeration object of type Boolean to contain the returned value of <var>NotAtEnd</var>.
  For more information about Boolean enumerations, see [[Using Boolean enumerations]]. </td></tr>
  For more information about Boolean enumerations, see [[Using Boolean enumerations]]. </td></tr>
<tr><th>%tok</th>
<tr><th>%tok</th>
<td>A StringTokenizer object variable.</td></tr>
<td>A <var>StringTokenizer</var> object variable.</td></tr>
</table>
</table>
==Usage notes==
==Usage notes==
Line 21: Line 21:
<li>The tokenizing position may be after the last token but
<li>The tokenizing position may be after the last token but
not necessarily at the end of the token string.
not necessarily at the end of the token string.
In the following code sequence, the return from NotAtEnd is <tt>True</tt>
In the following code sequence, the return from <var>NotAtEnd</var> is <tt>True</tt>
and the position is not at the end of the string:
and the position is not at the end of the string:
<pre>
<pre>
Line 28: Line 28:
     %tok:notAtEnd
     %tok:notAtEnd
</pre>
</pre>
<li>[[AtEnd (StringTokenizer function)|AtEnd]] is the reverse of NotAtEnd:
<li>[[AtEnd (StringTokenizer function)|AtEnd]] is the reverse of <var>NotAtEnd</var>:
it returns a value of <tt>False</tt>
it returns a value of <tt>False</tt>
if the current tokenizing position is not at the end of the string.
if the current tokenizing position is not at the end of the string.

Revision as of 21:47, 6 February 2011

Is present tokenizing position at end of tokenizerstring? (StringTokenizer class)


This method returns a Boolean value that indicates whether or not the present tokenizing position is after the last token in the tokenizer string. The value is True if the position is not after the last token; otherwise it is False.

The tokenizing position is given by NextPosition.

Syntax

%boolean = stringTokenizer:NotAtEnd

Syntax terms

%bool An enumeration object of type Boolean to contain the returned value of NotAtEnd. For more information about Boolean enumerations, see Using Boolean enumerations.
%tok A StringTokenizer object variable.

Usage notes

  • The tokenizing position may be after the last token but not necessarily at the end of the token string. In the following code sequence, the return from NotAtEnd is True and the position is not at the end of the string:
        %tok:string = 'example      '
        %tok:nextPosition = 10
        %tok:notAtEnd
    
  • AtEnd is the reverse of NotAtEnd: it returns a value of False if the current tokenizing position is not at the end of the string.

See also