com.google.javascript.jscomp

Class ComposeWarningsGuard

java.lang.Object

com.google.javascript.jscomp.WarningsGuard

com.google.javascript.jscomp.ComposeWarningsGuard

All Implemented Interfaces:

java.io.Serializable

public class ComposeWarningsGuard
extends WarningsGuard

WarningsGuard that represents just a chain of other guards. For example we could have following chain 1) all warnings outside of /foo/ should be suppressed 2) errors with key JSC_BAR should be marked as warning 3) the rest should be reported as error This class is designed for such behavior.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ComposeWarningsGuard.GuardComparator

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

WarningsGuard.Priority

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	demoteErrors
private java.util.Comparator<WarningsGuard>	guardComparator
private java.util.TreeSet<WarningsGuard>	guards
private int	numberOfAdds
private java.util.Map<WarningsGuard,java.lang.Integer>	orderOfAddition
private static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
ComposeWarningsGuard(java.util.List<WarningsGuard> guards)
ComposeWarningsGuard(WarningsGuard... guards)

Method Summary

Modifier and Type	Method and Description
(package private) void	addGuard(WarningsGuard guard)
private void	addGuards(java.lang.Iterable<WarningsGuard> guards)
boolean	disables(DiagnosticGroup group) Returns whether all warnings in the given diagnostic group will be filtered out.
boolean	enables(DiagnosticGroup group) Determines whether this guard will "elevate" the status of any disabled diagnostic type in the group to a warning or an error.
(package private) java.util.List<WarningsGuard>	getGuards()
CheckLevel	level(JSError error) Returns a new check level for a given error.
(package private) ComposeWarningsGuard	makeEmergencyFailSafeGuard() Make a warnings guard that's the same as this one but demotes all errors to warnings.
protected ComposeWarningsGuard	makeNonStrict() Make a warnings guard that's the same as this one but with all escalating guards turned down.
java.lang.String	toString()

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

getPriority

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

orderOfAddition

private final java.util.Map<WarningsGuard,java.lang.Integer> orderOfAddition

numberOfAdds

private int numberOfAdds

guardComparator

private final java.util.Comparator<WarningsGuard> guardComparator

demoteErrors

private boolean demoteErrors

guards

private final java.util.TreeSet<WarningsGuard> guards

Constructor Detail

ComposeWarningsGuard

public ComposeWarningsGuard(java.util.List<WarningsGuard> guards)

ComposeWarningsGuard

public ComposeWarningsGuard(WarningsGuard... guards)

Method Detail

addGuard

void addGuard(WarningsGuard guard)

addGuards

private void addGuards(java.lang.Iterable<WarningsGuard> guards)

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.

disables

public boolean disables(DiagnosticGroup group)

Description copied from class: WarningsGuard

Returns whether all warnings in the given diagnostic group will be filtered out. Used to determine which passes to skip.

Overrides:

disables in class WarningsGuard

Parameters:

group - A group of DiagnosticTypes.

Returns:

Whether all warnings of these types are disabled by this guard.

enables

public boolean enables(DiagnosticGroup group)

Determines whether this guard will "elevate" the status of any disabled diagnostic type in the group to a warning or an error.

Overrides:

enables in class WarningsGuard

Parameters:

group - A group of DiagnosticTypes.

Returns:

Whether any warnings of these types are enabled by this guard.

getGuards

java.util.List<WarningsGuard> getGuards()

makeEmergencyFailSafeGuard

ComposeWarningsGuard makeEmergencyFailSafeGuard()

Make a warnings guard that's the same as this one but demotes all errors to warnings.

makeNonStrict

protected ComposeWarningsGuard makeNonStrict()

Description copied from class: WarningsGuard

Make a warnings guard that's the same as this one but with all escalating guards turned down.

Overrides:

makeNonStrict in class WarningsGuard

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object