com.google.api.tools.framework.model

Class DiagSuppressor

java.lang.Object

com.google.api.tools.framework.model.DiagSuppressor

public class DiagSuppressor
extends java.lang.Object

Manages the set of rules for suppressing Diag.Kind.WARNING Diags. TODO(user): Change DiagSuppressor to implement DiagCollector and use this as the DiagCollector in Model.java, pending work in cl/121629221

Constructor Summary

Constructors

Constructor and Description
DiagSuppressor(DiagCollector diagCollector)

Method Summary

Modifier and Type	Method and Description
void	addPattern(Element elem, java.lang.String pattern)
void	addSuppressionDirective(Element elem, java.lang.String directive, java.util.List<ConfigAspect> configAspects) Adds a user-level suppression directive.
java.util.regex.Pattern	getPattern(Element elem)
boolean	isSuppressedWarning(Diag diag, Element elem) Checks whether the given diagnosis is suppressed for the given element.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiagSuppressor

public DiagSuppressor(DiagCollector diagCollector)

Method Detail

addSuppressionDirective

public void addSuppressionDirective(Element elem,
                                    java.lang.String directive,
                                    java.util.List<ConfigAspect> configAspects)

Adds a user-level suppression directive. The directive must be given in the form 'aspect-rule', or 'aspect-*' to match any rule. Is used in comments such as '(== suppress_warning http-* ==)' which will suppress all lint warnings generated by the http aspect.

isSuppressedWarning

public boolean isSuppressedWarning(Diag diag,
                                   Element elem)

Checks whether the given diagnosis is suppressed for the given element. This checks the suppression pattern for this element and all elements, inserting the model for global suppressions as a virtual parent. Only Diags of Kind Diag.Kind.WARNING can be suppressed

addPattern

public void addPattern(Element elem,
                       java.lang.String pattern)

getPattern

@Nullable
public java.util.regex.Pattern getPattern(Element elem)