Package com.intellij.codeInspection

Class SuppressionUtil

java.lang.Object

com.intellij.codeInspection.SuppressionUtilCore

com.intellij.codeInspection.SuppressionUtil

public class SuppressionUtil
extends SuppressionUtilCore

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALL
static java.lang.String	COMMON_SUPPRESS_REGEXP Common part of regexp for suppressing in line comments for different languages.
static java.util.regex.Pattern	SUPPRESS_IN_LINE_COMMENT_PATTERN

Fields inherited from class com.intellij.codeInspection.SuppressionUtilCore

SUPPRESS_INSPECTIONS_TAG_NAME

Method Summary

Modifier and Type	Method and Description
static PsiComment	createComment(Project project, java.lang.String commentText, Language language)
static void	createSuppression(Project project, PsiElement container, java.lang.String id, Language commentLanguage)
static java.lang.String	getLineCommentPrefix(PsiElement comment)
static PsiElement	getStatementToolSuppressedIn(PsiElement place, java.lang.String toolId, java.lang.Class<? extends PsiElement> statementClass)
static PsiElement	getStatementToolSuppressedIn(PsiElement place, java.lang.String toolId, java.lang.Class<? extends PsiElement> statementClass, java.util.regex.Pattern suppressInLineCommentPattern)
static boolean	inspectionResultSuppressed(PsiElement place, InspectionProfileEntry tool)
static boolean	inspectionResultSuppressed(PsiElement place, LocalInspectionTool tool)
static boolean	isInspectionToolIdMentioned(java.lang.String inspectionsList, java.lang.String inspectionToolID)
static boolean	isSuppressed(PsiElement psiElement, java.lang.String id)
static boolean	isSuppressedInStatement(PsiElement place, java.lang.String toolId, java.lang.Class<? extends PsiElement> statementClass)
static boolean	isSuppressionComment(PsiElement comment)
static void	replaceSuppressionComment(PsiElement comment, java.lang.String id, boolean replaceOtherSuppressionIds, Language commentLanguage)

Methods inherited from class java.lang.Object

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

Field Detail

COMMON_SUPPRESS_REGEXP

public static final java.lang.String COMMON_SUPPRESS_REGEXP

Common part of regexp for suppressing in line comments for different languages. Comment start prefix isn't included, e.g. add '//' for Java/C/JS or '#' for Ruby

See Also:

Constant Field Values

SUPPRESS_IN_LINE_COMMENT_PATTERN

public static final java.util.regex.Pattern SUPPRESS_IN_LINE_COMMENT_PATTERN

ALL

public static final java.lang.String ALL

See Also:

Constant Field Values

Method Detail

isInspectionToolIdMentioned

public static boolean isInspectionToolIdMentioned(java.lang.String inspectionsList,
                                                  java.lang.String inspectionToolID)

getStatementToolSuppressedIn

public static PsiElement getStatementToolSuppressedIn(PsiElement place,
                                                      java.lang.String toolId,
                                                      java.lang.Class<? extends PsiElement> statementClass)

getStatementToolSuppressedIn

public static PsiElement getStatementToolSuppressedIn(PsiElement place,
                                                      java.lang.String toolId,
                                                      java.lang.Class<? extends PsiElement> statementClass,
                                                      java.util.regex.Pattern suppressInLineCommentPattern)

isSuppressedInStatement

public static boolean isSuppressedInStatement(PsiElement place,
                                              java.lang.String toolId,
                                              java.lang.Class<? extends PsiElement> statementClass)

createComment

public static PsiComment createComment(Project project,
                                       java.lang.String commentText,
                                       Language language)

getLineCommentPrefix

public static java.lang.String getLineCommentPrefix(PsiElement comment)

isSuppressionComment

public static boolean isSuppressionComment(PsiElement comment)

replaceSuppressionComment

public static void replaceSuppressionComment(PsiElement comment,
                                             java.lang.String id,
                                             boolean replaceOtherSuppressionIds,
                                             Language commentLanguage)

createSuppression

public static void createSuppression(Project project,
                                     PsiElement container,
                                     java.lang.String id,
                                     Language commentLanguage)

isSuppressed

public static boolean isSuppressed(PsiElement psiElement,
                                   java.lang.String id)

inspectionResultSuppressed

public static boolean inspectionResultSuppressed(PsiElement place,
                                                 LocalInspectionTool tool)

inspectionResultSuppressed

public static boolean inspectionResultSuppressed(PsiElement place,
                                                 InspectionProfileEntry tool)