Channel (SonarSource :: Cobol :: Javadoc 5.0.0.5433 API)

java.lang.Object
- org.sonar.sslr.channel.Channel<O>

Direct Known Subclasses:

BlackHoleChannel, BomCharacterChannel, ChannelDispatcher, CommentRegexpChannel, IdentifierAndKeywordChannel, PunctuatorChannel, RegexChannel, RegexpChannel, UnknownCharacterChannel
```
public abstract class Channel<O>
extends Object
```

Constructor Summary

Constructors
Constructor Description

Channel()

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`abstract boolean`	`consume(CodeReader code, O output)`	Tries to consume the character stream at the current reading cursor position (provided by the `CodeReader`).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Channel
```
public Channel()
```
- Method Detail
  - consume
```
public abstract boolean consume(CodeReader code,
                                O output)
```
    Tries to consume the character stream at the current reading cursor position (provided by the CodeReader). If the character stream is consumed the method must return true and the OUTPUT object can be fed.
    
    Parameters:
    
    code - the handle on the input character stream
    
    output - the OUTPUT that can be optionally fed by the Channel
    
    Returns:
    
    false if the Channel doesn't want to consume the character stream, true otherwise.