NotAtEnd (StringTokenizer function)

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

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

Syntax

%boolean = stringTokenizer:NotAtEnd

Syntax terms

%boolean	An enumeration object of type Boolean to contain the returned value of NotAtEnd. The result is true if any tokens remain, starting from NextPosition, and false if no tokens remain.
stringTokenizer	A StringTokenizer object expression.

Usage notes

• It is illegal to scan for a token past the CurrentToken if NotAtEnd is false.
• 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.
• NextTokenPosition 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 false and the position is not at the end of the string:

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

• AtEnd is the reverse of NotAtEnd: it returns a false value if the current tokenizing position is not at the end of the string.

See also

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