Package com.intellij.psi

Interface PsiDirectory

All Superinterfaces:

Iconable, Navigatable, NavigatablePsiElement, NavigationItem, PsiCheckedRenameElement, PsiElement, PsiFileSystemItem, PsiNamedElement, UserDataHolder

All Known Implementing Classes:

PsiDirectoryImpl, PsiJavaDirectoryImpl

public interface PsiDirectory
extends PsiFileSystemItem

Represents a file system directory and allows to access its contents.

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.util.Iconable

Iconable.IconFlags, Iconable.LastComputedIcon

Field Summary

Fields

Modifier and Type	Field and Description
static PsiDirectory[]	EMPTY_ARRAY The empty array of PSI directories which can be reused to avoid unnecessary allocations.

Fields inherited from interface com.intellij.psi.PsiElement

ARRAY_FACTORY

Fields inherited from interface com.intellij.openapi.util.Iconable

ICON_FLAG_IGNORE_MASK, ICON_FLAG_OPEN, ICON_FLAG_READ_STATUS, ICON_FLAG_VISIBILITY

Fields inherited from interface com.intellij.psi.NavigatablePsiElement

EMPTY_NAVIGATABLE_ELEMENT_ARRAY

Fields inherited from interface com.intellij.navigation.NavigationItem

EMPTY_NAVIGATION_ITEM_ARRAY

Method Summary

Modifier and Type	Method and Description
void	checkCreateFile(java.lang.String name) Checks if it's possible to create a file with the specified name in the directory, and throws an exception if the creation is not possible.
void	checkCreateSubdirectory(java.lang.String name) Checks if it's possible to create a subdirectory with the specified name in the directory, and throws an exception if the creation is not possible.
PsiFile	copyFileFrom(java.lang.String newName, PsiFile originalFile)
PsiFile	createFile(java.lang.String name) Creates a file with the specified name in the directory.
PsiDirectory	createSubdirectory(java.lang.String name) Creates a subdirectory with the specified name in the directory.
PsiFile	findFile(java.lang.String name) Finds a file with the specified name in this directory.
PsiDirectory	findSubdirectory(java.lang.String name) Finds the subdirectory of this directory with the specified name.
PsiFile []	getFiles() Returns the list of files in the directory.
java.lang.String	getName() Returns the name of the element.
PsiDirectory	getParent() Returns the parent of the PSI element.
PsiDirectory	getParentDirectory() Returns the parent directory of the directory.
PsiDirectory []	getSubdirectories() Returns the list of subdirectories of this directory.
VirtualFile	getVirtualFile() Returns the virtual file represented by the PSI directory.
PsiElement	setName(java.lang.String name) Renames the element.

Methods inherited from interface com.intellij.psi.PsiFileSystemItem

isDirectory, processChildren

Methods inherited from interface com.intellij.psi.PsiCheckedRenameElement

checkSetName

Methods inherited from interface com.intellij.psi.PsiElement

accept, acceptChildren, add, addAfter, addBefore, addRange, addRangeAfter, addRangeBefore, checkAdd, checkDelete, copy, delete, deleteChildRange, findElementAt, findReferenceAt, getChildren, getContainingFile, getContext, getCopyableUserData, getFirstChild, getLanguage, getLastChild, getManager, getNavigationElement, getNextSibling, getNode, getOriginalElement, getOwnReferences, getPrevSibling, getProject, getReference, getReferences, getResolveScope, getStartOffsetInParent, getText, getTextLength, getTextOffset, getTextRange, getTextRangeInParent, getUseScope, isEquivalentTo, isPhysical, isValid, isWritable, processDeclarations, putCopyableUserData, replace, textContains, textMatches, textMatches, textToCharArray, toString

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Methods inherited from interface com.intellij.openapi.util.Iconable

getIcon

Methods inherited from interface com.intellij.navigation.NavigationItem

getPresentation

Methods inherited from interface com.intellij.pom.Navigatable

canNavigate, canNavigateToSource, navigate

Field Detail

EMPTY_ARRAY

static final PsiDirectory[] EMPTY_ARRAY

The empty array of PSI directories which can be reused to avoid unnecessary allocations.

Method Detail

getVirtualFile

VirtualFile getVirtualFile()

Returns the virtual file represented by the PSI directory.

Specified by:

getVirtualFile in interface PsiFileSystemItem

Returns:

the virtual file instance.

getName

java.lang.String getName()

Description copied from interface: PsiNamedElement

Returns the name of the element.

Specified by:

getName in interface NavigationItem

Specified by:

getName in interface PsiFileSystemItem

Specified by:

getName in interface PsiNamedElement

Returns:

the element name.

setName

PsiElement setName(java.lang.String name)
            throws IncorrectOperationException

Description copied from interface: PsiNamedElement

Renames the element.

Specified by:

setName in interface PsiNamedElement

Parameters:

name - the new element name.

Returns:

the element corresponding to this element after the rename (either this or a different element if the rename caused the element to be replaced).

Throws:

IncorrectOperationException - if the modification is not supported or not possible for some reason.

getParentDirectory

PsiDirectory getParentDirectory()

Returns the parent directory of the directory.

Returns:

the parent directory, or null if the directory has no parent.

getParent

PsiDirectory getParent()

Description copied from interface: PsiElement

Returns the parent of the PSI element.

Specified by:

getParent in interface PsiElement

Specified by:

getParent in interface PsiFileSystemItem

Returns:

the parent of the element, or null if the element has no parent.

getSubdirectories

PsiDirectory [] getSubdirectories()

Returns the list of subdirectories of this directory.

Returns:

the array of subdirectories.

getFiles

PsiFile [] getFiles()

Returns the list of files in the directory.

Returns:

the array of files.

findSubdirectory

PsiDirectory findSubdirectory(java.lang.String name)

Finds the subdirectory of this directory with the specified name.

Parameters:

name - the name of the subdirectory to find.

Returns:

the subdirectory instance, or null if no subdirectory with such a name is found.

findFile

PsiFile findFile(java.lang.String name)

Finds a file with the specified name in this directory.

Parameters:

name - the name of the file to find.

Returns:

the file instance, or null if no file with such a name is found.

createSubdirectory

PsiDirectory createSubdirectory(java.lang.String name)
                         throws IncorrectOperationException

Creates a subdirectory with the specified name in the directory.

Parameters:

name - the name of the subdirectory to create.

Returns:

the created directory instance.

Throws:

IncorrectOperationException - if the operation failed for some reason.

checkCreateSubdirectory

void checkCreateSubdirectory(java.lang.String name)
                      throws IncorrectOperationException

Checks if it's possible to create a subdirectory with the specified name in the directory, and throws an exception if the creation is not possible. Does not actually modify anything.

Parameters:

name - the name of the subdirectory to check creation possibility.

Throws:

IncorrectOperationException - if the creation is not possible.

createFile

PsiFile createFile(java.lang.String name)
            throws IncorrectOperationException

Creates a file with the specified name in the directory.

Parameters:

name - the name of the file to create.

Returns:

the created file instance.

Throws:

IncorrectOperationException - if the operation failed for some reason.

copyFileFrom

PsiFile copyFileFrom(java.lang.String newName,
                     PsiFile originalFile)
              throws IncorrectOperationException

Throws:

IncorrectOperationException

checkCreateFile

void checkCreateFile(java.lang.String name)
              throws IncorrectOperationException

Checks if it's possible to create a file with the specified name in the directory, and throws an exception if the creation is not possible. Does not actually modify anything.

Parameters:

name - the name of the file to check creation possibility.

Throws:

IncorrectOperationException - if the creation is not possible.