AtEnd (StringTokenizer function)

Is current tokenizing position at the end of the string? (StringTokenizer class)

This method returns a Boolean value that is true if no tokens remain starting from NextPosition.

Syntax

%boolean = stringTokenizer:AtEnd

Syntax terms

%boolean	An enumeration object of type Boolean to contain the returned value of AtEnd. The result is true if no tokens remain, starting from NextPosition, and false if any tokens remain. For more information about Boolean enumerations, see "Using Boolean Enumerations".
stringTokenizer	A stringTokenizer object.

Usage notes

• It is illegal to scan for a token past the CurrentToken if AtEnd is true.
• For Spaces tokenization, a token remains if there are any non-Spaces characters remaining at or after NextPosition.
• For Separators tokenization, a token remains if either:
  • NextPosition is less than or equal to the length of the String.
  • Either a token has not been located in the String, or the last method which located a token found a separator at the end of the String.
• NextPosition may be after the last token but not necessarily at the end of the token string. In the following code sequence, the return from AtEnd is true and the position is not at the end of the string:

  %tok = 'example ':stringTokenizer %tok:nextPosition = 8 printText {~=%tok:atEnd}

• NotAtEnd is the reverse of AtEnd: it returns true if any tokens remain starting with NextToken.

Examples

The following request selects the string's tokens one after another until the end of the string is detected:

begin %tok is object stringtokenizer %tok = new %tok:string = 'Content-Type: text/plain; charset="US-ASCII"' repeat while not %tok:atEnd printText {~} is {%tok:nextToken} end repeat end

The result is:

%tok:nextToken is Content-Type: %tok:nextToken is text/plain; %tok:nextToken is charset="US-ASCII"

See also

StringTokenizer class	List of StringTokenizer methods	StringTokenizer methods syntax
Notation conventions for methods