Package com.intellij.codeInsight.daemon.quickFix

Class CreateFilePathFix

java.lang.Object

com.intellij.codeInspection.LocalQuickFixOnPsiElement

com.intellij.codeInspection.LocalQuickFixAndIntentionActionOnPsiElement

com.intellij.codeInsight.daemon.quickFix.AbstractCreateFileFix

com.intellij.codeInsight.daemon.quickFix.CreateFilePathFix

All Implemented Interfaces:

FileModifier, IntentionAction, LocalQuickFix, QuickFix<ProblemDescriptor>, WriteActionAware

public class CreateFilePathFix
extends AbstractCreateFileFix

Quick fix that creates a new file in one of the target directories. Automatically creates all intermediate directories of TargetDirectory.getPathToCreate() and NewFileLocation.getSubPath(). If there are multiple target directories it shows a popup where users can select desired target directory.

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.codeInsight.daemon.quickFix.AbstractCreateFileFix

AbstractCreateFileFix.TargetDirectoryListItem

Field Summary

Fields inherited from class com.intellij.codeInsight.daemon.quickFix.AbstractCreateFileFix

CURRENT_DIRECTORY_REF, myDirectories, myIsAvailable, myIsAvailableTimeStamp, myKey, myNewFileName, mySubPath, PARENT_DIRECTORY_REF

Fields inherited from class com.intellij.codeInspection.LocalQuickFixOnPsiElement

LOG, myEndElement, myStartElement

Fields inherited from interface com.intellij.codeInsight.intention.IntentionAction

EMPTY_ARRAY

Fields inherited from interface com.intellij.codeInspection.LocalQuickFix

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
CreateFilePathFix(PsiElement psiElement, NewFileLocation newFileLocation)
CreateFilePathFix(PsiElement psiElement, NewFileLocation newFileLocation, java.lang.String fileText, java.lang.String fixLocaleKey)
CreateFilePathFix(PsiElement psiElement, NewFileLocation newFileLocation, java.util.function.Supplier<java.lang.String> fileTextSupplier)

Method Summary

Modifier and Type	Method and Description
protected void	apply(Project project, PsiDirectory targetDirectory, Editor editor)
PsiElement	getElementToMakeWritable(PsiFile file) Controls whether this intention/fix is going to modify the current file.
java.lang.String	getFamilyName() Returns the name of the family of intentions.
protected java.lang.String	getFileText()
java.lang.String	getText() Returns text to be shown in the list of available actions, if this action is available.
protected void	openFile(Project project, PsiDirectory directory, PsiFile newFile, java.lang.String text)

Methods inherited from class com.intellij.codeInsight.daemon.quickFix.AbstractCreateFileFix

invoke, isAvailable

Methods inherited from class com.intellij.codeInspection.LocalQuickFixAndIntentionActionOnPsiElement

invoke, invoke, isAvailable, isAvailable, startInWriteAction

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

Constructor Detail

CreateFilePathFix

public CreateFilePathFix(PsiElement psiElement,
                         NewFileLocation newFileLocation,
                         java.lang.String fileText,
                         java.lang.String fixLocaleKey)

CreateFilePathFix

public CreateFilePathFix(PsiElement psiElement,
                         NewFileLocation newFileLocation)

CreateFilePathFix

public CreateFilePathFix(PsiElement psiElement,
                         NewFileLocation newFileLocation,
                         java.util.function.Supplier<java.lang.String> fileTextSupplier)

Method Detail

openFile

protected void openFile(Project project,
                        PsiDirectory directory,
                        PsiFile newFile,
                        java.lang.String text)

getFileText

protected java.lang.String getFileText()

getText

public java.lang.String getText()

Description copied from interface: IntentionAction

Returns text to be shown in the list of available actions, if this action is available.

Specified by:

getText in interface IntentionAction

Specified by:

getText in class LocalQuickFixOnPsiElement

Returns:

the text to show in the intention popup.

See Also:

IntentionAction.isAvailable(Project, Editor, PsiFile)

getFamilyName

public java.lang.String getFamilyName()

Description copied from interface: IntentionAction

Returns the name of the family of intentions. It is used to externalize "auto-show" state of intentions. When the user clicks on a light bulb in intention list, all intentions with the same family name get enabled/disabled. The name is also shown in settings tree.

Returns:

the intention family name.

See Also:

IntentionManager.registerIntentionAndMetaData(IntentionAction, String...)

getElementToMakeWritable

public PsiElement getElementToMakeWritable(PsiFile file)

Description copied from interface: FileModifier

Controls whether this intention/fix is going to modify the current file. If @NotNull, and the current file is read-only, it will be made writable (honoring version control integration) before the intention/fix is invoked.

By default, as a heuristic, returns the same as WriteActionAware.startInWriteAction().

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 false from WriteActionAware.startInWriteAction(), and call FileModificationService methods in the implementation, and take write actions yourself as needed.

Parameters:

file - the same file where intention would be invoked (for LocalQuickFix it would be the containing file of ProblemDescriptor.getPsiElement())

apply

protected void apply(Project project,
                     PsiDirectory targetDirectory,
                     Editor editor)
              throws IncorrectOperationException

Specified by:

apply in class AbstractCreateFileFix

Throws:

IncorrectOperationException