Package com.intellij.codeInsight.intention

Class AddAnnotationPsiFix

java.lang.Object

com.intellij.codeInspection.LocalQuickFixOnPsiElement

com.intellij.codeInsight.intention.AddAnnotationPsiFix

All Implemented Interfaces:

FileModifier, LocalQuickFix, QuickFix<ProblemDescriptor>, WriteActionAware

Direct Known Subclasses:

AddAnnotationFix, AddNullableNotNullAnnotationFix

public class AddAnnotationPsiFix
extends LocalQuickFixOnPsiElement

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	myAnnotation
protected java.lang.String	myText

Fields inherited from class com.intellij.codeInspection.LocalQuickFixOnPsiElement

LOG, myEndElement, myStartElement

Fields inherited from interface com.intellij.codeInspection.LocalQuickFix

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
AddAnnotationPsiFix(java.lang.String fqn, PsiModifierListOwner modifierListOwner, PsiNameValuePair [] values, java.lang.String... annotationsToRemove)

Method Summary

Modifier and Type	Method and Description
static PsiAnnotation	addPhysicalAnnotation(java.lang.String fqn, PsiNameValuePair[] pairs, PsiModifierList modifierList)
static PsiAnnotation	addPhysicalAnnotationTo(java.lang.String fqn, PsiNameValuePair[] pairs, PsiAnnotationOwner owner)
static java.lang.String	calcText(PsiModifierListOwner modifierListOwner, java.lang.String annotation)
static AddAnnotationPsiFix	createAddNotNullFix(PsiModifierListOwner owner) Creates a fix which will add default "NotNull" annotation to the given element.
static AddAnnotationPsiFix	createAddNullableFix(PsiModifierListOwner owner) Creates a fix which will add default "Nullable" annotation to the given element.
protected java.lang.String []	getAnnotationsToRemove()
static PsiModifierListOwner	getContainer(PsiFile file, int offset)
static PsiModifierListOwner	getContainer(PsiFile file, int offset, boolean availableOnReference)
java.lang.String	getFamilyName()
java.lang.String	getText()
void	invoke(Project project, PsiFile file, PsiElement startElement, PsiElement endElement)
boolean	isAvailable(Project project, PsiFile file, PsiElement startElement, PsiElement endElement)
static boolean	isAvailable(PsiModifierListOwner modifierListOwner, java.lang.String annotationFQN)
static boolean	isNullabilityAnnotationApplicable(PsiModifierListOwner owner)
static void	removePhysicalAnnotations(PsiModifierListOwner owner, java.lang.String... fqns)
boolean	startInWriteAction() Indicate whether this action should be invoked inside write action.

Methods inherited from class com.intellij.codeInspection.LocalQuickFixOnPsiElement

applyFix, applyFix, getEndElement, getName, getStartElement, isAvailable

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.codeInsight.intention.FileModifier

getElementToMakeWritable

Field Detail

myAnnotation

protected final java.lang.String myAnnotation

myText

protected final java.lang.String myText

Constructor Detail

AddAnnotationPsiFix

public AddAnnotationPsiFix(java.lang.String fqn,
                           PsiModifierListOwner modifierListOwner,
                           PsiNameValuePair [] values,
                           java.lang.String... annotationsToRemove)

Method Detail

calcText

public static java.lang.String calcText(PsiModifierListOwner modifierListOwner,
                                        java.lang.String annotation)

getContainer

public static PsiModifierListOwner getContainer(PsiFile file,
                                                int offset)

getContainer

public static PsiModifierListOwner getContainer(PsiFile file,
                                                int offset,
                                                boolean availableOnReference)

getText

public java.lang.String getText()

Specified by:

getText in class LocalQuickFixOnPsiElement

getFamilyName

public java.lang.String getFamilyName()

Returns:

text to appear in "Apply Fix" popup when multiple Quick Fixes exist (in the results of batch code inspection). For example, if the name of the quickfix is "Create template <filename>", the return value of getFamilyName() should be "Create template". If the name of the quickfix does not depend on a specific element, simply return QuickFix.getName().

isAvailable

public boolean isAvailable(Project project,
                           PsiFile file,
                           PsiElement startElement,
                           PsiElement endElement)

Overrides:

isAvailable in class LocalQuickFixOnPsiElement

isAvailable

public static boolean isAvailable(PsiModifierListOwner modifierListOwner,
                                  java.lang.String annotationFQN)

startInWriteAction

public boolean startInWriteAction()

Description copied from interface: WriteActionAware

Indicate whether this action should be invoked inside write action.

Should return false if e.g. modal dialog is shown inside the action. If false is returned the action itself is responsible for starting write action when needed, by calling Application.runWriteAction(Runnable).

Returns:

true if the action requires a write action (default), false otherwise.

invoke

public void invoke(Project project,
                   PsiFile file,
                   PsiElement startElement,
                   PsiElement endElement)

Specified by:

invoke in class LocalQuickFixOnPsiElement

addPhysicalAnnotation

public static PsiAnnotation addPhysicalAnnotation(java.lang.String fqn,
                                                  PsiNameValuePair[] pairs,
                                                  PsiModifierList modifierList)

addPhysicalAnnotationTo

public static PsiAnnotation addPhysicalAnnotationTo(java.lang.String fqn,
                                                    PsiNameValuePair[] pairs,
                                                    PsiAnnotationOwner owner)

removePhysicalAnnotations

public static void removePhysicalAnnotations(PsiModifierListOwner owner,
                                             java.lang.String... fqns)

getAnnotationsToRemove

protected java.lang.String [] getAnnotationsToRemove()

isNullabilityAnnotationApplicable

public static boolean isNullabilityAnnotationApplicable(PsiModifierListOwner owner)

createAddNullableFix

public static AddAnnotationPsiFix createAddNullableFix(PsiModifierListOwner owner)

Creates a fix which will add default "Nullable" annotation to the given element.

Parameters:

owner - an element to add the annotation

Returns:

newly created fix or null if adding nullability annotation is impossible for the specified element.

createAddNotNullFix

public static AddAnnotationPsiFix createAddNotNullFix(PsiModifierListOwner owner)

Creates a fix which will add default "NotNull" annotation to the given element.

Parameters:

owner - an element to add the annotation

Returns:

newly created fix or null if adding nullability annotation is impossible for the specified element.