Package uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing

Class CommentExtractor

java.lang.Object

uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.CommentExtractor

All Implemented Interfaces:

IGeneralPreProcessor, IPreProcessor

public class CommentExtractor
extends java.lang.Object
implements IGeneralPreProcessor

Constructor Summary

Constructors

Constructor	Description
CommentExtractor()

Method Summary

Modifier and Type	Method	Description
ILexerSpecification	getLexerSpecification()	Specifies which channels must be present in the lexer for the preprocessor to function, this is a minimum specification, other channels may be present.
java.util.List<? extends org.antlr.v4.runtime.Token>	process(java.util.List<? extends org.antlr.v4.runtime.Token> tokens, org.antlr.v4.runtime.Vocabulary vocab, java.lang.String lang)	Extracts the comments from a source file

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface uk.ac.warwick.dcs.sherlock.api.model.preprocessing.IGeneralPreProcessor

getDependencies

Constructor Detail

CommentExtractor

public CommentExtractor()

Method Detail

getLexerSpecification

public ILexerSpecification getLexerSpecification()

Description copied from interface: IGeneralPreProcessor

Specifies which channels must be present in the lexer for the preprocessor to function, this is a minimum specification, other channels may be present.

Specified by:

getLexerSpecification in interface IGeneralPreProcessor

Returns:

lexer specification

process

public java.util.List<? extends org.antlr.v4.runtime.Token> process(java.util.List<? extends org.antlr.v4.runtime.Token> tokens,
                                                                    org.antlr.v4.runtime.Vocabulary vocab,
                                                                    java.lang.String lang)

Extracts the comments from a source file

Specified by:

process in interface IGeneralPreProcessor

Parameters:

tokens - list of tokens to process

vocab - Lexer vocabulary

lang - language of source file being processed

Returns:

stream of tokens containing comments