org.springframework.extensions.surf

Class DojoDependencyRule

java.lang.Object

org.springframework.extensions.surf.DojoDependencyRule

Direct Known Subclasses:

DojoCssDependencyRule, DojoI18nDependencyRule, DojoNonAmdDependencyRule, DojoWidgetsDependencyRule

public class DojoDependencyRule
extends Object

This is the rule that is used to detect Dojo dependencies defined by the standard "define" function call in Dojo source files. It is also the class that should be inherited from when defining other rule classes.

Author:

David Draper

Constructor Summary

Constructors

Constructor and Description
DojoDependencyRule()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addJavaScriptDependency(DojoDependencies dependencies, String path) Adds the supplied path to the supplied DojoDependencies object if the path exists.
protected void	addNonAmdJavaScriptDependency(DojoDependencies dependencies, String path) Adds the supplied path to the supplied DojoDependencies object if the path exists.
String	getDeclarationRegex()
Pattern	getDeclarationRegexPattern()
DependencyHandler	getDependencyHandler()
String	getDependencyRegex()
Pattern	getDependencyRegexPattern()
DojoDependencyHandler	getDojoDependencyHandler()
int	getTargetGroup()
Map<Pattern,String>	getTokens() Gets the token map for replacing tokens in dependencies.
protected void	processDependency(String dependency, String sourcePath, String sourceContents, Matcher matcher, DojoDependencies dependencies)
protected void	processRegexRules(String filePath, String fileContents, DojoDependencies dependencies) This method processes the regular expression that has been defined to detect a group of dependencies.
protected String	replaceTokens(String input) Replaces any tokens in the supplied input String.
void	setDeclarationRegex(String declarationRegex)
void	setDependencyHandler(DependencyHandler dependencyHandler)
void	setDependencyRegex(String dependencyRegex)
void	setDojoDependencyHandler(DojoDependencyHandler dojoDependencyHandler)
void	setTargetGroup(int targetGroup)

Methods inherited from class java.lang.Object

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

Constructor Detail

DojoDependencyRule

public DojoDependencyRule()

Method Detail

getTokens

public Map<Pattern,String> getTokens()

Gets the token map for replacing tokens in dependencies.

Returns:

Map

replaceTokens

protected String replaceTokens(String input)

Replaces any tokens in the supplied input String. This currently isn't used by any of the default Surf dependency rules but has been left for extensions to make use of.

Parameters:

input - String

Returns:

The input String with tokens replaced.

processRegexRules

protected void processRegexRules(String filePath,
                     String fileContents,
                     DojoDependencies dependencies)

This method processes the regular expression that has been defined to detect a group of dependencies.

Parameters:

filePath - The path of the dependency that has been requested.

fileContents - The current modified file contents

dependencies - DojoDependencies

processDependency

protected void processDependency(String dependency,
                     String sourcePath,
                     String sourceContents,
                     Matcher matcher,
                     DojoDependencies dependencies)

Parameters:

dependency - The dependency as specified in the file being processed

sourcePath - The source where the file was being processed

sourceContents - TODO

dependencies - The current DojoDependencies object for source file being processed

addJavaScriptDependency

protected void addJavaScriptDependency(DojoDependencies dependencies,
                           String path)

Adds the supplied path to the supplied DojoDependencies object if the path exists. This uses the DependencyHandler to check the paths existence and that a InputStream can be returned from it.

Parameters:

dependencies - The DojoDependencies to update

path - The path to check and add

addNonAmdJavaScriptDependency

protected void addNonAmdJavaScriptDependency(DojoDependencies dependencies,
                                 String path)

Adds the supplied path to the supplied DojoDependencies object if the path exists. This uses the DependencyHandler to check the paths existence and that a InputStream can be returned from it.

Parameters:

dependencies - The DojoDependencies to update

path - The path to check and add

getDeclarationRegex

public String getDeclarationRegex()

getDeclarationRegexPattern

public Pattern getDeclarationRegexPattern()

setDeclarationRegex

public void setDeclarationRegex(String declarationRegex)

getDependencyRegex

public String getDependencyRegex()

getDependencyRegexPattern

public Pattern getDependencyRegexPattern()

setDependencyRegex

public void setDependencyRegex(String dependencyRegex)

getTargetGroup

public int getTargetGroup()

setTargetGroup

public void setTargetGroup(int targetGroup)

setDojoDependencyHandler

public void setDojoDependencyHandler(DojoDependencyHandler dojoDependencyHandler)

getDojoDependencyHandler

public DojoDependencyHandler getDojoDependencyHandler()

setDependencyHandler

public void setDependencyHandler(DependencyHandler dependencyHandler)

getDependencyHandler

public DependencyHandler getDependencyHandler()