Package com.sonar.sslr.impl.channel

Class BomCharacterChannel

java.lang.Object

org.sonar.sslr.channel.Channel<Lexer>

com.sonar.sslr.impl.channel.BomCharacterChannel

public class BomCharacterChannel
extends Channel<Lexer>

Ignores all BOM characters.

Since:

1.17

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BOM_CHAR

Constructor Summary

Constructors

Constructor	Description
BomCharacterChannel()

Method Summary

Modifier and Type	Method	Description
boolean	consume(CodeReader code, Lexer lexer)	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

Field Details

BOM_CHAR

public static final int BOM_CHAR

See Also:

• Constant Field Values

Constructor Details

BomCharacterChannel

public BomCharacterChannel()

Method Details

consume

public boolean consume(CodeReader code,
 Lexer lexer)

Description copied from class: Channel

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.

Specified by:

consume in class Channel<Lexer>

Parameters:

code - the handle on the input character stream

lexer - 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.