Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Eclipse Platform Release 3.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.eclipse.jface.text.rules
Interface ICharacterScanner

All Known Implementing Classes:
  RuleBasedScanner

public interface ICharacterScanner

Defines the interface of a character scanner used by rules. Rules may request the next character or ask the character scanner to unread the last read character.

Field Summary
`static int` | `EOF` The value returned when this scanner has read EOF.

Method Summary
`int` | `getColumn()` Returns the column of the character scanner.
`char[][]` | `getLegalLineDelimiters()` Provides rules access to the legal line delimiters.
`int` | `read()` Returns the next character or EOF if end of file has been reached
`void` | `unread()` Rewinds the scanner before the last read character.

Field Detail

### EOF

    public static final int EOF

  The value returned when this scanner has read EOF.

  See Also:
    Constant Field Values

Method Detail

### getLegalLineDelimiters

    public char[][] getLegalLineDelimiters()

  Provides rules access to the legal line delimiters.

  Returns:
    the legal line delimiters

### getColumn

    public int getColumn()

  Returns the column of the character scanner.

  Returns:
    the column of the character scanner

### read

    public int read()

  Returns the next character or EOF if end of file has been reached

  Returns:
    the next character or EOF

### unread

    public void unread()

  Rewinds the scanner before the last read character.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Eclipse Platform Release 3.0
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.