Package com.intellij.openapi.fileTypes

Class FileTypeRegistry

java.lang.Object

com.intellij.openapi.fileTypes.FileTypeRegistry

Direct Known Subclasses:

CoreFileTypeRegistry, FileTypeManager

public abstract class FileTypeRegistry
extends java.lang.Object

A service for retrieving file types for files.

Performance notice. There are different rules of file type matching for a file: matching by file name, by extension, by file content, by custom logic providers and so on. They are all executed by the general methods getFileTypeByFile, thus implying that execution of such methods is as long as the sum of all possible matching checks in the worst case. That includes reading file contents to feed to all FileTypeRegistry.FileTypeDetector instances, checking FileTypeIdentifiableByVirtualFile and so on. Such actions may lead to considerable slowdowns if used on large VirtualFile collections, e.g. in BulkFileListener implementations.

If it is possible and correct to restrict file type matching by particular means (e.g. match only by file name), it is advised to do so, in order to improve the performance of the check, e.g. use

 FileTypeRegistry.getInstance().getFileTypeByFileName(file.getNameSequence())
 

instead of

 file.getFileType()
 

Also, if you are interested not in getting file type, but rather comparing file type with a known one, prefer using isFileOfType(VirtualFile, FileType), as it is faster than getFileTypeByFile(VirtualFile) as well.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FileTypeRegistry.FileTypeDetector Pluggable file type detector by content

Field Summary

Fields

Modifier and Type	Field and Description
static Getter<FileTypeRegistry>	ourInstanceGetter

Constructor Summary

Constructors

Constructor and Description
FileTypeRegistry()

Method Summary

Modifier and Type	Method and Description
LanguageFileType	findFileTypeByLanguage(Language language)
abstract FileType	findFileTypeByName(java.lang.String fileTypeName) Finds a file type with the specified name.
abstract FileType	getFileTypeByExtension(java.lang.String extension) Returns the file type for the specified extension.
abstract FileType	getFileTypeByFile(VirtualFile file) Returns the file type for the specified file.
FileType	getFileTypeByFile(VirtualFile file, byte [] content) Returns the file type for the specified file.
FileType	getFileTypeByFileName(java.lang.CharSequence fileNameSeq) Returns the file type for the specified file name.
abstract FileType	getFileTypeByFileName(java.lang.String fileName) Same as getFileTypeByFileName(CharSequence) but receives String parameter.
static FileTypeRegistry	getInstance()
abstract FileType []	getRegisteredFileTypes() Returns the list of all registered file types.
abstract boolean	isFileIgnored(VirtualFile file)
boolean	isFileOfType(VirtualFile file, FileType type) Checks if the given file has the given file type.

Methods inherited from class java.lang.Object

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

Field Detail

ourInstanceGetter

public static Getter<FileTypeRegistry> ourInstanceGetter

Constructor Detail

FileTypeRegistry

public FileTypeRegistry()

Method Detail

isFileIgnored

public abstract boolean isFileIgnored(VirtualFile file)

isFileOfType

public boolean isFileOfType(VirtualFile file,
                            FileType type)

Checks if the given file has the given file type.

findFileTypeByLanguage

public LanguageFileType findFileTypeByLanguage(Language language)

getInstance

public static FileTypeRegistry getInstance()

getRegisteredFileTypes

public abstract FileType [] getRegisteredFileTypes()

Returns the list of all registered file types.

Returns:

The list of file types.

getFileTypeByFile

public abstract FileType getFileTypeByFile(VirtualFile file)

Returns the file type for the specified file.

Parameters:

file - The file for which the type is requested.

Returns:

The file type instance.

getFileTypeByFile

public FileType getFileTypeByFile(VirtualFile file,
                                  byte [] content)

Returns the file type for the specified file.

Parameters:

file - The file for which the type is requested.

content - Content of the file (if already available, to avoid reading from disk again)

Returns:

The file type instance.

getFileTypeByFileName

public FileType getFileTypeByFileName(java.lang.CharSequence fileNameSeq)

Returns the file type for the specified file name.

Parameters:

fileNameSeq - The file name for which the type is requested.

Returns:

The file type instance, or FileTypes.UNKNOWN if not found.

getFileTypeByFileName

public abstract FileType getFileTypeByFileName(java.lang.String fileName)

Same as getFileTypeByFileName(CharSequence) but receives String parameter. Consider to use the method above in case when you want to get VirtualFile's file type by file name.

getFileTypeByExtension

public abstract FileType getFileTypeByExtension(java.lang.String extension)

Returns the file type for the specified extension. Note that a more general way of obtaining file type is with getFileTypeByFile(VirtualFile)

Parameters:

extension - The extension for which the file type is requested, not including the leading '.'.

Returns:

The file type instance, or UnknownFileType.INSTANCE if corresponding file type not found

findFileTypeByName

public abstract FileType findFileTypeByName(java.lang.String fileTypeName)

Finds a file type with the specified name.