com.google.javascript.jscomp

Class ByPathWarningsGuard

java.lang.Object

com.google.javascript.jscomp.WarningsGuard

com.google.javascript.jscomp.ByPathWarningsGuard

All Implemented Interfaces:

java.io.Serializable

public final class ByPathWarningsGuard
extends WarningsGuard

An implementation of a WarningsGuard that can modify the CheckLevel based on the file that caused the warning, and whether this file matches a set of paths (specified either as include or exclude of path name parts).

For example:

 List<String> paths = new ArrayList<String>();
 paths.add("foo");
 WarningsGuard guard =
     ByPathWarningsGuard.forPath(paths, CheckLevel.ERROR, 1);
 

This guard will convert any warning that came from a file that contains "foo" in its path to an error.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.google.javascript.jscomp.WarningsGuard

WarningsGuard.Priority

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	include
private CheckLevel	level
private java.util.List<java.lang.String>	paths
private int	priority
private static long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ByPathWarningsGuard(java.util.List<java.lang.String> paths, boolean include, CheckLevel level) Constructs a new instance.

Method Summary

Modifier and Type	Method and Description
static ByPathWarningsGuard	exceptPath(java.util.List<java.lang.String> paths, CheckLevel level)
static ByPathWarningsGuard	forPath(java.util.List<java.lang.String> paths, CheckLevel level)
protected int	getPriority() The priority in which warnings guards are applied.
CheckLevel	level(JSError error) Returns a new check level for a given error.

Methods inherited from class com.google.javascript.jscomp.WarningsGuard

disables, enables, makeNonStrict

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

paths

private final java.util.List<java.lang.String> paths

include

private final boolean include

priority

private final int priority

level

private CheckLevel level

Constructor Detail

ByPathWarningsGuard

private ByPathWarningsGuard(java.util.List<java.lang.String> paths,
                            boolean include,
                            CheckLevel level)

Constructs a new instance. The priority is determined by the CheckLevel: ERROR have Priority.STRICT, and OFF have priority FILTER_BY_PATH. Use forPath(java.util.List<java.lang.String>, com.google.javascript.jscomp.CheckLevel) or exceptPath(java.util.List<java.lang.String>, com.google.javascript.jscomp.CheckLevel) to actually create a new instance.

Method Detail

forPath

public static ByPathWarningsGuard forPath(java.util.List<java.lang.String> paths,
                                          CheckLevel level)

Parameters:

paths - Paths for matching.

level - The CheckLevel to apply on affected files.

Returns:

a new ByPathWarningsGuard that would affect any file in the given set of paths.

exceptPath

public static ByPathWarningsGuard exceptPath(java.util.List<java.lang.String> paths,
                                             CheckLevel level)

Parameters:

paths - Paths for matching.

level - The CheckLevel to apply on affected files.

Returns:

a new ByPathWarningsGuard that would affect any file not in the given set of paths.

level

public CheckLevel level(JSError error)

Description copied from class: WarningsGuard

Returns a new check level for a given error. OFF - suppress it, ERROR - report as error. null means that this guard does not know what to do with the error. Null is extremely helpful when you have a chain of guards. If current guard returns null, then the next in the chain should process it.

Specified by:

level in class WarningsGuard

Parameters:

error - a reported error.

Returns:

what level given error should have.

getPriority

protected int getPriority()

Description copied from class: WarningsGuard

The priority in which warnings guards are applied. Lower means the guard will be applied sooner. Expressed on a scale of 1 to 100.

Overrides:

getPriority in class WarningsGuard