com.google.gwt.dev.resource.impl

Class PathPrefix

java.lang.Object

com.google.gwt.dev.resource.impl.PathPrefix

public final class PathPrefix
extends Object

Represents the abstract path prefix that goes between the ClassPathEntry and the rest of resource's abstract path. This concept allows us to specify subsets of path hierarchies orthogonally from path roots. For example, a path root might be /home/gwt/src/ and an abstract path prefix might be module/client/. Importantly, you can apply the same abstract path prefix to multiple path roots and find more than one set of resources residing in disjoint locations yet occupying the same logical hierarchy. Sorry this explanation is so abstract; it's how we model things like the GWT module's client source path, public path, and super source path.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PathPrefix.Judgement Represents whether or not a PathPrefix includes a particular file as well as an indicator of the inclusion/exclusion priority.

Field Summary

Fields

Modifier and Type	Field and Description
static PathPrefix	ALL

Constructor Summary

Constructors

Constructor and Description
PathPrefix(String prefix, ResourceFilter filter) Construct a non-rerooting prefix.
PathPrefix(String prefix, ResourceFilter filter, boolean shouldReroot) Construct a prefix without global exclusions.
PathPrefix(String moduleName, String prefix, ResourceFilter filter, boolean shouldReroot, String[] excludeList) Construct a prefix.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Equality is based on prefixes representing the same string.
PathPrefix.Judgement	getJudgement(String path) Determines the inclusion/exclusion status and priority of a given path.
String	getModuleName()
String	getPrefix() The prefix.
String	getRerootedPath(String path)
int	hashCode()
void	merge(PathPrefix pathPrefix) Consolidate a given PathPrefix with this one, such that resources excluded by neither prefix and included by either are allowed.
boolean	shouldReroot()
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass

Field Detail

ALL

public static final PathPrefix ALL

Constructor Detail

PathPrefix

public PathPrefix(String prefix,
                  ResourceFilter filter)

Construct a non-rerooting prefix.

Parameters:

prefix - a string prefix that (1) is the empty string or (2) begins with something other than a slash and ends with a slash

filter - the resource filter to use, or null for no filter; note that the filter must always return the same answer for the same candidate path (doing otherwise will produce inconsistent behavior in identifying available resources)

PathPrefix

public PathPrefix(String prefix,
                  ResourceFilter filter,
                  boolean shouldReroot)

Construct a prefix without global exclusions.

Parameters:

prefix - a string prefix that (1) is the empty string or (2) begins with something other than a slash and ends with a slash

filter - the resource filter to use, or null for no filter; note that the filter must always return the same answer for the same candidate path (doing otherwise will produce inconsistent behavior in identifying available resources)

shouldReroot - if true, any matching Resource for this prefix will be rerooted to not include the initial prefix path; if false, the prefix will be included in a matching resource's path.

PathPrefix

public PathPrefix(String moduleName,
                  String prefix,
                  ResourceFilter filter,
                  boolean shouldReroot,
                  String[] excludeList)

Construct a prefix.

Parameters:

moduleName - the name of the module that contained the Source or Public entry that this PathPrefix represents

prefix - a string prefix that (1) is the empty string or (2) begins with something other than a slash and ends with a slash

filter - the resource filter to use, or null for no filter; note that the filter must always return the same answer for the same candidate path (doing otherwise will produce inconsistent behavior in identifying available resources)

shouldReroot - if true, any matching Resource for this prefix will be rerooted to not include the initial prefix path; if false, the prefix will be included in a matching resource's path.

excludeList - list of globs that should be removed from any module's resources.

Method Detail

getJudgement

public PathPrefix.Judgement getJudgement(String path)

Determines the inclusion/exclusion status and priority of a given path.

Determination is made using the prefix path, list of exclusions and list of filters (which are constructed from "includes" and "skips" entries in the xml).

equals

public boolean equals(Object obj)

Equality is based on prefixes representing the same string. Importantly, the filter does not affect equality.

Overrides:

equals in class Object

getPrefix

public String getPrefix()

The prefix.

Returns:

the result is guaranteed to be non-null, and either be the empty string or it will not begin with a slash and will end with a slash; these guarantees are very useful when concatenating paths that incorporate prefixes

getRerootedPath

public String getRerootedPath(String path)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

merge

public void merge(PathPrefix pathPrefix)

Consolidate a given PathPrefix with this one, such that resources excluded by neither prefix and included by either are allowed.

Parameters:

pathPrefix -

shouldReroot

public boolean shouldReroot()

toString

public String toString()

Overrides:

toString in class Object

getModuleName

public String getModuleName()