CharacterStream (magic-script 1.4.0 API)

java.lang.Object
- org.ssssssss.script.parsing.CharacterStream

```
public class CharacterStream
extends Object
```
Wraps a the content of a Source and handles traversing the contained characters. Manages a current Span via the startSpan() and endSpan() methods.

构造器概要

构造器
构造器和说明

CharacterStream(String source)

CharacterStream(String source, int start, int end)

构造器
构造器和说明
`CharacterStream(String source)`
`CharacterStream(String source, int start, int end)`

方法概要

All Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`char`	`consume()` Returns the next character and advance the stream
`Span`	`endSpan()` Completes the span started with `startSpan()` at the current stream position.
`int`	`getPosition()` Returns the current character position in the stream.
`Span`	`getSpan(int start, int end)`
`boolean`	`hasMore()` Returns whether there are more characters in the stream
`boolean`	`match(String needle, boolean consume)` Matches the given needle with the next characters.
`boolean`	`matchDigit(boolean consume)` Returns whether the next character is a digit and optionally consumes it.
`boolean`	`matchIdentifierPart(boolean consume)` Returns whether the next character is the start of an identifier and optionally consumes it.
`boolean`	`matchIdentifierStart(boolean consume)` Returns whether the next character is the start of an identifier and optionally consumes it.
`char`	`peek()` Returns the next character without advancing the stream
`void`	`reset(int position)`
`void`	`skipLine()`
`void`	`skipUntil(String chars)`
`void`	`skipWhiteSpace()` Skips any number of successive whitespace characters.
`void`	`startSpan()` Start a new Span at the current stream position.
`String`	`substring(int startIndex, int endIndex)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - CharacterStream
```
public CharacterStream(String source)
```
  - CharacterStream
```
public CharacterStream(String source,
                       int start,
                       int end)
```
- 方法详细资料
  - substring
```
public String substring(int startIndex,
                        int endIndex)
```
  - hasMore
```
public boolean hasMore()
```
    Returns whether there are more characters in the stream
  - peek
```
public char peek()
```
    Returns the next character without advancing the stream
  - getSpan
```
public Span getSpan(int start,
                    int end)
```
  - consume
```
public char consume()
```
    Returns the next character and advance the stream
  - match
```
public boolean match(String needle,
                     boolean consume)
```
    Matches the given needle with the next characters. Returns true if the needle is matched, false otherwise. If there's a match and consume is true, the stream is advanced by the needle's length.
  - matchDigit
```
public boolean matchDigit(boolean consume)
```
    Returns whether the next character is a digit and optionally consumes it.
  - matchIdentifierStart
```
public boolean matchIdentifierStart(boolean consume)
```
    Returns whether the next character is the start of an identifier and optionally consumes it. Adheres to Character.isJavaIdentifierStart(char).
  - matchIdentifierPart
```
public boolean matchIdentifierPart(boolean consume)
```
    Returns whether the next character is the start of an identifier and optionally consumes it. Adheres to Character.isJavaIdentifierPart(char).
  - skipLine
```
public void skipLine()
```
  - skipUntil
```
public void skipUntil(String chars)
```
  - skipWhiteSpace
```
public void skipWhiteSpace()
```
    Skips any number of successive whitespace characters.
  - startSpan
```
public void startSpan()
```
    Start a new Span at the current stream position. Call endSpan() to complete the span.
  - endSpan
```
public Span endSpan()
```
    Completes the span started with startSpan() at the current stream position.
  - getPosition
```
public int getPosition()
```
    Returns the current character position in the stream.
  - reset
```
public void reset(int position)
```

类 CharacterStream

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

CharacterStream

CharacterStream

方法详细资料

substring

hasMore

peek

getSpan

consume

match

matchDigit

matchIdentifierStart

matchIdentifierPart

skipLine

skipUntil

skipWhiteSpace

startSpan

endSpan

getPosition

reset