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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	RefasterJsScanner.RefasterJsTemplate Class that holds the before and after templates for a given RefasterJs refactoring.

Field Summary

Fields

Modifier and Type	Field and Description
private RefasterJsScanner.RefasterJsTemplate	matchedTemplate The RefasterJsTemplate that matched the last Match.
private java.lang.String	templateJs The JS code that contains the RefasterJs templates.
private com.google.common.collect.ImmutableList<RefasterJsScanner.RefasterJsTemplate>	templates All templates that were found in the template file.

Constructor Summary

Constructors

Constructor and Description
RefasterJsScanner()

Method Summary

Modifier and Type	Method and Description
(package private) void	initialize(AbstractCompiler compiler) Initializes the Scanner class by loading the template JS file, compiling it, and then finding all matching RefasterJs template functions in the file.
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.
java.util.List<SuggestedFix>	processMatch(Match match) Processes one Match at a time.
private Node	transformNode(Node templateNode, java.util.Map<java.lang.String,Node> templateNodeToMatchMap) Transforms the template node to a replacement node by mapping the template names to the ones that were matched against in the JsSourceMatcher.

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

Field Detail

templateJs

private java.lang.String templateJs

The JS code that contains the RefasterJs templates.

templates

private com.google.common.collect.ImmutableList<RefasterJsScanner.RefasterJsTemplate> templates

All templates that were found in the template file.

matchedTemplate

private RefasterJsScanner.RefasterJsTemplate matchedTemplate

The RefasterJsTemplate that matched the last Match.

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

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

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 java.util.List<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.

transformNode

private Node transformNode(Node templateNode,
                           java.util.Map<java.lang.String,Node> templateNodeToMatchMap)

Transforms the template node to a replacement node by mapping the template names to the ones that were matched against in the JsSourceMatcher.

initialize

void initialize(AbstractCompiler compiler)
         throws java.lang.Exception

Initializes the Scanner class by loading the template JS file, compiling it, and then finding all matching RefasterJs template functions in the file.

Throws:

java.lang.Exception