Package com.puppycrawl.tools.checkstyle

Class XpathFileGeneratorAstFilter

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.XpathFileGeneratorAstFilter

All Implemented Interfaces:

Configurable, Contextualizable, TreeWalkerFilter

public class XpathFileGeneratorAstFilter
extends AutomaticBean
implements TreeWalkerFilter

Catches TreeWalkerAuditEvent and generates corresponding xpath query. Stores violations and xpath queries map inside static variable for XpathFileGeneratorAuditListener. See issue #102 https://github.com/checkstyle/checkstyle/issues/102

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

AutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	DELIMITER	The delimiter between xpath queries.
private static final Map<Violation,String>	MESSAGE_QUERY_MAP	Map from Violation objects to xpath queries.
private int	tabWidth	The distance between tab stop position.

Constructor Summary

Constructors

Constructor	Description
XpathFileGeneratorAstFilter()

Method Summary

Modifier and Type	Method	Description
boolean	accept(TreeWalkerAuditEvent event)	Determines whether or not a filtered TreeWalkerAuditEvent is accepted.
static String	findCorrespondingXpathQuery(AuditEvent event)	Returns xpath query corresponding to violation of the TreeWalkerAuditEvent object which points to the same AST element as specified AuditEvent object.
protected void	finishLocalSetup()	Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.
void	setTabWidth(int tabWidth)	Sets tab width.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Field Details

DELIMITER

private static final String DELIMITER

The delimiter between xpath queries.

See Also:

• Constant Field Values

MESSAGE_QUERY_MAP

private static final Map<Violation,String> MESSAGE_QUERY_MAP

Map from Violation objects to xpath queries.

tabWidth

private int tabWidth

The distance between tab stop position.

Constructor Details

XpathFileGeneratorAstFilter

public XpathFileGeneratorAstFilter()

Method Details

setTabWidth

public void setTabWidth(int tabWidth)

Sets tab width.

Parameters:

tabWidth - the distance between tab stops

findCorrespondingXpathQuery

public static String findCorrespondingXpathQuery(AuditEvent event)

Returns xpath query corresponding to violation of the TreeWalkerAuditEvent object which points to the same AST element as specified AuditEvent object.

Parameters:

event - the AuditEvent object.

Returns:

returns corresponding xpath query

finishLocalSetup

protected void finishLocalSetup()

Description copied from class: AutomaticBean

Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.

The default implementation does nothing.

Specified by:

finishLocalSetup in class AutomaticBean

accept

public boolean accept(TreeWalkerAuditEvent event)

Description copied from interface: TreeWalkerFilter

Determines whether or not a filtered TreeWalkerAuditEvent is accepted.

Specified by:

accept in interface TreeWalkerFilter

Parameters:

event - the TreeWalkerAuditEvent to filter.

Returns:

true if the event is accepted.