Package com.intellij.openapi.fileTypes.impl

Class FileTypeManagerImpl

java.lang.Object

com.intellij.openapi.fileTypes.FileTypeRegistry

com.intellij.openapi.fileTypes.FileTypeManager

com.intellij.openapi.fileTypes.ex.FileTypeManagerEx

com.intellij.openapi.fileTypes.impl.FileTypeManagerImpl

All Implemented Interfaces:

PersistentStateComponent<Element>, Disposable

public class FileTypeManagerImpl
extends FileTypeManagerEx
implements PersistentStateComponent<Element>, Disposable

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.openapi.fileTypes.FileTypeRegistry

FileTypeRegistry.FileTypeDetector

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields inherited from class com.intellij.openapi.fileTypes.FileTypeManager

TOPIC

Fields inherited from class com.intellij.openapi.fileTypes.FileTypeRegistry

ourInstanceGetter

Constructor Summary

Constructors

Constructor and Description
FileTypeManagerImpl()

Method Summary

Modifier and Type	Method and Description
void	addFileTypeListener(FileTypeListener listener) Adds a listener for receiving notifications about changes in the list of registered file types.
void	associate(FileType type, FileNameMatcher matcher)
void	associate(FileType fileType, FileNameMatcher matcher, boolean fireChange)
void	dispose() Usually not invoked directly, see class javadoc.
void	drainReDetectQueue()
LanguageFileType	findFileTypeByLanguage(Language language)
FileType	findFileTypeByName(java.lang.String fileTypeName) Finds a file type with the specified name.
void	fireBeforeFileTypesChanged()
void	fireFileTypesChanged()
void	freezeFileTypeTemporarilyIn(VirtualFile file, java.lang.Runnable runnable)
java.lang.String []	getAssociatedExtensions(FileType type) Returns the list of extensions associated with the specified file type.
java.util.List<FileNameMatcher>	getAssociations(FileType type)
FileType	getByFile(VirtualFile file)
java.lang.String	getExtension(java.lang.String fileName)
FileType	getFileTypeByExtension(java.lang.String extension) Returns the file type for the specified extension.
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 fileName) Returns the file type for the specified file name.
FileType	getFileTypeByFileName(java.lang.String fileName) Same as FileTypeRegistry.getFileTypeByFileName(CharSequence) but receives String parameter.
java.lang.String	getIgnoredFilesList() Returns the semicolon-delimited list of patterns for files and folders which are excluded from the project structure though they may be present physically on disk.
FileType	getKnownFileTypeOrAssociate(VirtualFile file) If file is already associated with any known file type returns it.
FileType	getKnownFileTypeOrAssociate(VirtualFile file, Project project)
FileType []	getRegisteredFileTypes() Returns the list of all registered file types.
Element	getState()
FileType	getStdFileType(java.lang.String name)
void	initializeComponent() If class also is a component, then this method will be called after loading state (even if not state) but only once throughout the life cycle
boolean	isFileIgnored(java.lang.String name) Checks if the specified file is ignored by the IDE.
boolean	isFileIgnored(VirtualFile file)
boolean	isIgnoredFilesListEqualToCurrent(java.lang.String list)
void	loadState(Element state) This method is called when new component state is loaded.
protected byte	readFlagsFromCache(VirtualFile file)
void	registerFileType(FileType fileType) Deprecated.
void	registerFileType(FileType type, java.util.List<? extends FileNameMatcher> defaultAssociations)
void	removeAssociation(FileType type, FileNameMatcher matcher)
void	removeAssociation(FileType fileType, FileNameMatcher matcher, boolean fireChange)
void	removeFileTypeListener(FileTypeListener listener) Removes a listener for receiving notifications about changes in the list of registered file types.
void	setIgnoredFilesList(java.lang.String list) Sets new list of semicolon-delimited patterns for files and folders which are excluded from the project structure.
void	unregisterFileType(FileType fileType)
protected void	writeFlagsToCache(VirtualFile file, int flags)

Methods inherited from class com.intellij.openapi.fileTypes.ex.FileTypeManagerEx

getInstanceEx

Methods inherited from class com.intellij.openapi.fileTypes.FileTypeManager

associateExtension, associatePattern, getInstance, parseFromString, registerFileType, removeAssociatedExtension

Methods inherited from class com.intellij.openapi.fileTypes.FileTypeRegistry

isFileOfType

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.components.PersistentStateComponent

noStateLoaded

Constructor Detail

FileTypeManagerImpl

public FileTypeManagerImpl()

Method Detail

drainReDetectQueue

public void drainReDetectQueue()

getStdFileType

public FileType getStdFileType(java.lang.String name)

Specified by:

getStdFileType in class FileTypeManager

initializeComponent

public void initializeComponent()

Description copied from interface: PersistentStateComponent

If class also is a component, then this method will be called after loading state (even if not state) but only once throughout the life cycle

Specified by:

initializeComponent in interface PersistentStateComponent<Element>

getFileTypeByFileName

public FileType getFileTypeByFileName(java.lang.String fileName)

Description copied from class: FileTypeRegistry

Same as FileTypeRegistry.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.

Specified by:

getFileTypeByFileName in class FileTypeRegistry

getFileTypeByFileName

public FileType getFileTypeByFileName(java.lang.CharSequence fileName)

Description copied from class: FileTypeRegistry

Returns the file type for the specified file name.

Overrides:

getFileTypeByFileName in class FileTypeRegistry

Parameters:

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

Returns:

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

freezeFileTypeTemporarilyIn

public void freezeFileTypeTemporarilyIn(VirtualFile file,
                                        java.lang.Runnable runnable)

getFileTypeByFile

public FileType getFileTypeByFile(VirtualFile file)

Description copied from class: FileTypeRegistry

Returns the file type for the specified file.

Specified by:

getFileTypeByFile in class FileTypeRegistry

Parameters:

file - The file for which the type is requested.

Returns:

The file type instance.

getFileTypeByFile

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

Description copied from class: FileTypeRegistry

Returns the file type for the specified file.

Overrides:

getFileTypeByFile in class FileTypeRegistry

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.

getByFile

public FileType getByFile(VirtualFile file)

readFlagsFromCache

protected byte readFlagsFromCache(VirtualFile file)

writeFlagsToCache

protected void writeFlagsToCache(VirtualFile file,
                                 int flags)

findFileTypeByName

public FileType findFileTypeByName(java.lang.String fileTypeName)

Description copied from class: FileTypeRegistry

Finds a file type with the specified name.

Specified by:

findFileTypeByName in class FileTypeRegistry

findFileTypeByLanguage

public LanguageFileType findFileTypeByLanguage(Language language)

Overrides:

findFileTypeByLanguage in class FileTypeRegistry

getFileTypeByExtension

public FileType getFileTypeByExtension(java.lang.String extension)

Description copied from class: FileTypeRegistry

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

Specified by:

getFileTypeByExtension in class FileTypeRegistry

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

registerFileType

@Deprecated
public void registerFileType(FileType fileType)

Deprecated.

Specified by:

registerFileType in class FileTypeManagerEx

registerFileType

public void registerFileType(FileType type,
                             java.util.List<? extends FileNameMatcher> defaultAssociations)

Specified by:

registerFileType in class FileTypeManager

unregisterFileType

public void unregisterFileType(FileType fileType)

Specified by:

unregisterFileType in class FileTypeManagerEx

getRegisteredFileTypes

public FileType [] getRegisteredFileTypes()

Description copied from class: FileTypeRegistry

Returns the list of all registered file types.

Specified by:

getRegisteredFileTypes in class FileTypeRegistry

Returns:

The list of file types.

getExtension

public java.lang.String getExtension(java.lang.String fileName)

Specified by:

getExtension in class FileTypeManagerEx

getIgnoredFilesList

public java.lang.String getIgnoredFilesList()

Description copied from class: FileTypeManager

Returns the semicolon-delimited list of patterns for files and folders which are excluded from the project structure though they may be present physically on disk.

Specified by:

getIgnoredFilesList in class FileTypeManager

Returns:

Semicolon-delimited list of patterns.

setIgnoredFilesList

public void setIgnoredFilesList(java.lang.String list)

Description copied from class: FileTypeManager

Sets new list of semicolon-delimited patterns for files and folders which are excluded from the project structure.

Specified by:

setIgnoredFilesList in class FileTypeManager

Parameters:

list - List of semicolon-delimited patterns.

isIgnoredFilesListEqualToCurrent

public boolean isIgnoredFilesListEqualToCurrent(java.lang.String list)

Specified by:

isIgnoredFilesListEqualToCurrent in class FileTypeManagerEx

isFileIgnored

public boolean isFileIgnored(java.lang.String name)

Description copied from class: FileTypeManager

Checks if the specified file is ignored by the IDE. Ignored files are not visible in different project views and cannot be opened in the editor. They will neither be parsed nor compiled.

Specified by:

isFileIgnored in class FileTypeManager

Parameters:

name - The name of the file to check.

Returns:

true if the file is ignored, false otherwise.

isFileIgnored

public boolean isFileIgnored(VirtualFile file)

Specified by:

isFileIgnored in class FileTypeRegistry

getAssociatedExtensions

public java.lang.String [] getAssociatedExtensions(FileType type)

Description copied from class: FileTypeManager

Returns the list of extensions associated with the specified file type.

Specified by:

getAssociatedExtensions in class FileTypeManager

Parameters:

type - The file type for which the extensions are requested.

Returns:

The array of extensions associated with the file type.

getAssociations

public java.util.List<FileNameMatcher> getAssociations(FileType type)

Specified by:

getAssociations in class FileTypeManager

associate

public void associate(FileType type,
                      FileNameMatcher matcher)

Specified by:

associate in class FileTypeManager

removeAssociation

public void removeAssociation(FileType type,
                              FileNameMatcher matcher)

Specified by:

removeAssociation in class FileTypeManager

fireBeforeFileTypesChanged

public void fireBeforeFileTypesChanged()

Specified by:

fireBeforeFileTypesChanged in class FileTypeManagerEx

fireFileTypesChanged

public void fireFileTypesChanged()

Specified by:

fireFileTypesChanged in class FileTypeManagerEx

addFileTypeListener

public void addFileTypeListener(FileTypeListener listener)

Description copied from class: FileTypeManager

Adds a listener for receiving notifications about changes in the list of registered file types.

Specified by:

addFileTypeListener in class FileTypeManager

Parameters:

listener - The listener instance.

removeFileTypeListener

public void removeFileTypeListener(FileTypeListener listener)

Description copied from class: FileTypeManager

Removes a listener for receiving notifications about changes in the list of registered file types.

Specified by:

removeFileTypeListener in class FileTypeManager

Parameters:

listener - The listener instance.

loadState

public void loadState(Element state)

Description copied from interface: PersistentStateComponent

This method is called when new component state is loaded. The method can and will be called several times, if config files were externally changed while IDE was running.

State object should be used directly, defensive copying is not required.

Specified by:

loadState in interface PersistentStateComponent<Element>

Parameters:

state - loaded component state

See Also:

XmlSerializerUtil.copyBean(Object, Object)

getState

public Element getState()

Specified by:

getState in interface PersistentStateComponent<Element>

Returns:

a component state. All properties, public and annotated fields are serialized. Only values, which differ from the default (i.e., the value of newly instantiated class) are serialized. null value indicates that the returned state won't be stored, as a result previously stored state will be used.

See Also:

XmlSerializer

associate

public void associate(FileType fileType,
                      FileNameMatcher matcher,
                      boolean fireChange)

removeAssociation

public void removeAssociation(FileType fileType,
                              FileNameMatcher matcher,
                              boolean fireChange)

getKnownFileTypeOrAssociate

public FileType getKnownFileTypeOrAssociate(VirtualFile file)

Description copied from class: FileTypeManager

If file is already associated with any known file type returns it. Otherwise asks user to select file type and associates it with fileName extension if any selected.

Overrides:

getKnownFileTypeOrAssociate in class FileTypeManager

Parameters:

file - file to ask for file type association

Returns:

Known file type or null. Never returns FileTypes.UNKNOWN.

getKnownFileTypeOrAssociate

public FileType getKnownFileTypeOrAssociate(VirtualFile file,
                                            Project project)

Specified by:

getKnownFileTypeOrAssociate in class FileTypeManager

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable