com.google.javascript.refactoring

Class Scanner

java.lang.Object

com.google.javascript.refactoring.Scanner

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

RefasterJsScanner

public abstract class Scanner
extends Object
implements Serializable

Class that developers should implement to perform a JsFlume refactoring.

Author:

[email protected] (Mark Knichel)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Scanner()

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	matches(Node node, NodeMetadata t) Returns true if the given node and node traversal should match for this particular scanner.
List<SuggestedFix>	processAllMatches(Collection<Match> matches) Processes every given match at one time.
List<SuggestedFix>	processMatch(Match match) Processes one Match at a time.

Methods inherited from class java.lang.Object

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

Constructor Detail

Scanner

public Scanner()

Method Detail

matches

public abstract boolean matches(Node node,
              NodeMetadata t)

Returns true if the given node and node traversal should match for this particular scanner. Typically this function uses the Matcher class or predefined matchers from Matchers to match against the Node and NodeMetadata. If this function returns true, a Match for this node will be passed to processMatch(Match) and all matches will be passed to #processAlMatches(Collection) at the end of the traversal.

processMatch

public List<SuggestedFix> processMatch(Match match)

Processes one Match at a time. There is no order guaranteed for when this function will be called with the Match.

Parameters:

match - The Match from the node and traversal for any match that matches(com.google.javascript.rhino.Node, com.google.javascript.refactoring.NodeMetadata) returned true for.

Returns:

List of SuggestedFix classes that will be applied to the source files at the end of the run to create the refactoring CL.

processAllMatches

public List<SuggestedFix> processAllMatches(Collection<Match> matches)

Processes every given match at one time. This function can be used when the refactoring needs the information from the entire run to perform the refactoring, such as moving functions around.

Parameters:

matches - All the Match matches that were collected when the matches(com.google.javascript.rhino.Node, com.google.javascript.refactoring.NodeMetadata) function returned true.

Returns:

List of SuggestedFix classes that will be applied to the source files at the end of the run to create the refactoring CL.