MDS/openide
1
0
Fork 0
mirror of https://gitflic.ru/project/openide/openide.git synced 2026-09-27 10:03:11 +07:00
Code Issues Packages Projects Releases Wiki Activity

give more clear name and javadoc

Browse Source
This commit is contained in:
Anna.Kozlova
2016-11-28 15:38:48 +01:00
parent 08091da5a9
commit 249953cfcf
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
platform/analysis-api/src/com/intellij/codeInsight/intention/IntentionLike.java
+6 -4
View File
@@ -30,17 +30,19 @@ import org.jetbrains.annotations.Nullable;
public interface IntentionLike extends WriteActionAware {
/**
* Controls whether this intention/fix is going to modify the file.
* If {@code @NotNull}, and the file is read-only,
* Controls whether this intention/fix is going to modify the current file.
* If {@code @NotNull}, and the current file is read-only,
* it will be made writable (honoring version control integration) before the intention/fix is invoked. <p/>
*
* By default, as a heuristic, returns the same as {@link #startInWriteAction()}.<p/>
*
* If the action is going to modify multiple files, or the set of the files is unknown in advance, please
* don't bother overriding this method, return {@code false} from {@link #startInWriteAction()}, and call {@link com.intellij.codeInsight.FileModificationService} methods in the implementation, and take write actions yourself as needed.
*
* @param currentFile the same file where intention would be invoked (for {@link com.intellij.codeInspection.LocalQuickFix} it would be the containing file of {@link com.intellij.codeInspection.ProblemDescriptor#getPsiElement})
*/
@Nullable
default PsiElement getElementToMakeWritable(@NotNull PsiFile file) {
return startInWriteAction() ? file : null;
default PsiElement getElementToMakeWritable(@NotNull PsiFile currentFile) {
return startInWriteAction() ? currentFile : null;
}
}