Package com.puppycrawl.tools.checkstyle
Class XpathFileGeneratorAstFilter
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
-
- com.puppycrawl.tools.checkstyle.XpathFileGeneratorAstFilter
-
- All Implemented Interfaces:
Configurable
,Contextualizable
,TreeWalkerFilter
public class XpathFileGeneratorAstFilter extends AbstractAutomaticBean implements TreeWalkerFilter
CatchesTreeWalkerAuditEvent
and generates corresponding xpath query. Stores violations and xpath queries map inside static variable forXpathFileGeneratorAuditListener
. See issue #102
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
AbstractAutomaticBean.OutputStreamOptions
-
-
Constructor Summary
Constructors Constructor Description XpathFileGeneratorAstFilter()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
accept(TreeWalkerAuditEvent event)
Determines whether or not a filteredTreeWalkerAuditEvent
is accepted.static String
findCorrespondingXpathQuery(AuditEvent event)
Returns xpath query corresponding to violation of theTreeWalkerAuditEvent
object which points to the same AST element as specifiedAuditEvent
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.AbstractAutomaticBean
configure, contextualize, getConfiguration, setupChild
-
-
-
-
Field Detail
-
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 fromViolation
objects to xpath queries.
-
tabWidth
private int tabWidth
The distance between tab stop position.
-
-
Constructor Detail
-
XpathFileGeneratorAstFilter
public XpathFileGeneratorAstFilter()
-
-
Method Detail
-
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 theTreeWalkerAuditEvent
object which points to the same AST element as specifiedAuditEvent
object.- Parameters:
event
- theAuditEvent
object.- Returns:
- returns corresponding xpath query
-
finishLocalSetup
protected void finishLocalSetup()
Description copied from class:AbstractAutomaticBean
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 classAbstractAutomaticBean
-
accept
public boolean accept(TreeWalkerAuditEvent event)
Description copied from interface:TreeWalkerFilter
Determines whether or not a filteredTreeWalkerAuditEvent
is accepted.- Specified by:
accept
in interfaceTreeWalkerFilter
- Parameters:
event
- the TreeWalkerAuditEvent to filter.- Returns:
- true if the event is accepted.
-
-