com.google.javascript.refactoring

Class RefasterJsScanner

java.lang.Object

com.google.javascript.refactoring.Scanner

com.google.javascript.refactoring.RefasterJsScanner

All Implemented Interfaces:

java.io.Serializable

public final class RefasterJsScanner
extends Scanner

Class that drives the RefasterJs refactoring by matching against a provided template JS file and then applying a transformation based off the template JS.

Author:

[email protected] (Mark Knichel)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RefasterJsScanner()

Method Summary

Modifier and Type	Method and Description
void	clearTemplates() Clears the RefasterJs templates used for comparison.
void	loadRefasterJsTemplate(java.lang.String refasterjsTemplate) Loads the RefasterJs template.
void	loadRefasterJsTemplateFromCode(java.lang.String refasterJsTemplate) Loads the RefasterJs template.
boolean	matches(Node node, NodeMetadata metadata) Returns true if the given node and node traversal should match for this particular scanner.
com.google.common.collect.ImmutableList<SuggestedFix>	processMatch(Match match) Processes one Match at a time.
void	setTypeMatchingStrategy(TypeMatchingStrategy typeMatchingStrategy) Sets the type matching strategy to use when matching templates.

Methods inherited from class com.google.javascript.refactoring.Scanner

processAllMatches

Methods inherited from class java.lang.Object

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

Constructor Detail

RefasterJsScanner

public RefasterJsScanner()

Method Detail

loadRefasterJsTemplate

public void loadRefasterJsTemplate(java.lang.String refasterjsTemplate)
                            throws java.io.IOException

Loads the RefasterJs template. This must be called before the scanner is used.

Throws:

java.io.IOException

setTypeMatchingStrategy

public void setTypeMatchingStrategy(TypeMatchingStrategy typeMatchingStrategy)

Sets the type matching strategy to use when matching templates.

Defaults to TypeMatchingStrategy.SUBTYPES.

loadRefasterJsTemplateFromCode

public void loadRefasterJsTemplateFromCode(java.lang.String refasterJsTemplate)
                                    throws java.io.IOException

Loads the RefasterJs template. This must be called before the scanner is used.

Throws:

java.io.IOException

clearTemplates

public void clearTemplates()

Clears the RefasterJs templates used for comparison. This function should be called if this class is going to be used with multiple Compiler objects since type comparison is dependent on the compiler used to generate the types.

matches

public boolean matches(Node node,
                       NodeMetadata metadata)

Description copied from class: Scanner

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 Scanner.processMatch(Match) and all matches will be passed to Scanner.processAllMatches(Collection) at the end of the traversal.

Specified by:

matches in class Scanner

processMatch

public com.google.common.collect.ImmutableList<SuggestedFix> processMatch(Match match)

Description copied from class: Scanner

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

Overrides:

processMatch in class Scanner

Parameters:

match - The Match from the node and traversal for any match that Scanner.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.