com.google.gwt.dev.resource.impl

Class PathPrefixSet

java.lang.Object

com.google.gwt.dev.resource.impl.PathPrefixSet

public class PathPrefixSet
extends Object

Combines the information conveyed about a set of path prefixes to quickly answer questions regarding an entire set of path prefixes.

Is effectively immutable and should not be modified after initial use.

Constructor Summary

Constructors

Constructor and Description
PathPrefixSet()
PathPrefixSet(boolean mergePathPrefixes)

Method Summary

Modifier and Type	Method and Description
boolean	add(PathPrefix prefix)
int	getSize()
boolean	includesDirectory(String dirPath) Determines whether or not a directory might have resources that could be included.
ResourceResolution	includesResource(String resourceAbstractPathName) Determines whether or not a given resource should be allowed by this path prefix set and the corresponding filters.
ResourceResolution	includesResource(String resourceAbstractPathName, String[] parts) Dives down the package hierarchy looking for the most specific package that applies to this resource.
boolean	mergePathPrefixes()
String	toString()
Collection<PathPrefix>	values()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode

Constructor Detail

PathPrefixSet

public PathPrefixSet()

PathPrefixSet

public PathPrefixSet(boolean mergePathPrefixes)

Method Detail

add

public boolean add(PathPrefix prefix)

Parameters:

prefix - the prefix to add

Returns:

true if the prefix was not already in the set; otherwise, it merged with one having the same prefix, which has the effect of expanding the filter (the merge works as union(includes - skips) - union(excludes))

getSize

public int getSize()

includesDirectory

public boolean includesDirectory(String dirPath)

Determines whether or not a directory might have resources that could be included. The primary purpose of this method is to allow ClassPathEntry subclasses to avoid descending into directory hierarchies that could not possibly contain resources that would be included by includesResource(String)

Parameters:

dirPath - must be a valid abstract directory name (must not be an empty string)

Returns:

true if some PathPrefix allows the directory

includesResource

public ResourceResolution includesResource(String resourceAbstractPathName)

Determines whether or not a given resource should be allowed by this path prefix set and the corresponding filters.

Parameters:

resourceAbstractPathName -

Returns:

matching PathPrefix if the resource matches some specified prefix and any associated filters don't exclude it. Otherwise, returns null. So it returns null if either no prefixes match or the most specific prefix excludes the resource.

includesResource

public ResourceResolution includesResource(String resourceAbstractPathName,
                                           String[] parts)

Dives down the package hierarchy looking for the most specific package that applies to this resource. The filter of the most specific package is the final determiner of inclusion/exclusion, such that more specific subpackages can override the filter settings on less specific superpackages.

mergePathPrefixes

public boolean mergePathPrefixes()

toString

public String toString()

Overrides:

toString in class Object

values

public Collection<PathPrefix> values()