Package net.sourceforge.pmd.cpd.token

Class AntlrTokenFilter

java.lang.Object

net.sourceforge.pmd.cpd.token.internal.BaseTokenFilter<AntlrToken>

net.sourceforge.pmd.cpd.token.AntlrTokenFilter

All Implemented Interfaces:

TokenFilter

public class AntlrTokenFilter
extends net.sourceforge.pmd.cpd.token.internal.BaseTokenFilter<AntlrToken>

A generic filter for Antlr-based token managers that allows to use comments to enable / disable analysis of parts of the stream

Constructor Summary

Constructors

Constructor	Description
AntlrTokenFilter(AntlrTokenManager tokenManager)	Creates a new AntlrTokenFilter

Method Summary

Modifier and Type	Method	Description
protected boolean	shouldStopProcessing(AntlrToken currentToken)	Extension point for subclasses to indicate when to stop filtering tokens.

Methods inherited from class net.sourceforge.pmd.cpd.token.internal.BaseTokenFilter

analyzeToken, analyzeTokens, getNextToken, isLanguageSpecificDiscarding

Methods inherited from class java.lang.Object

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

Constructor Detail

AntlrTokenFilter

public AntlrTokenFilter(AntlrTokenManager tokenManager)

Creates a new AntlrTokenFilter

Parameters:

tokenManager - The token manager from which to retrieve tokens to be filtered

Method Detail

shouldStopProcessing

protected boolean shouldStopProcessing(AntlrToken currentToken)

Description copied from class: net.sourceforge.pmd.cpd.token.internal.BaseTokenFilter

Extension point for subclasses to indicate when to stop filtering tokens.

Specified by:

shouldStopProcessing in class net.sourceforge.pmd.cpd.token.internal.BaseTokenFilter<AntlrToken>

Parameters:

currentToken - The token to be analyzed

Returns:

True if the token filter has finished consuming all tokens, false otherwise