Method: CommonTokenFactory#initialize

Defined in:
lib/antlr4/CommonTokenFactory.rb

#initialize(_copyText = false) ⇒ CommonTokenFactory

Returns a new instance of CommonTokenFactory.



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# File 'lib/antlr4/CommonTokenFactory.rb', line 19

def initialize(_copyText=false)
    # Indicates whether {@link CommonToken#setText} should be called after
    # constructing tokens to explicitly set the text. This is useful for cases
    # where the input stream might not be able to provide arbitrary substrings
    # of text from the input after the lexer creates a token (e.g. the
    # implementation of {@link CharStream#getText} in
    # {@link UnbufferedCharStream} throws an
    # {@link UnsupportedOperationException}). Explicitly setting the token text
    # allows {@link Token#getText} to be called at any time regardless of the
    # input stream implementation.
    #
    # <p>
    # The default value is {@code false} to avoid the performance and memory
    # overhead of copying text for every token unless explicitly requested.</p>
    #
    @copyText = _copyText
end