Package com.intellij.openapi.fileTypes

Class FileTypeManager

java.lang.Object

com.intellij.openapi.fileTypes.FileTypeRegistry

com.intellij.openapi.fileTypes.FileTypeManager

Direct Known Subclasses:

FileTypeManagerEx, MockFileTypeManager

public abstract class FileTypeManager
extends FileTypeRegistry

Manages the relationship between filenames and FileType instances.

Nested Class Summary

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

FileTypeRegistry.FileTypeDetector

Field Summary

Fields

Modifier and Type	Field and Description
static Topic<FileTypeListener>	TOPIC

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

ourInstanceGetter

Constructor Summary

Constructors

Constructor and Description
FileTypeManager()

Method Summary

Modifier and Type	Method and Description
abstract void	addFileTypeListener(FileTypeListener listener) Deprecated. Subscribe to TOPIC on any message bus level instead.
abstract void	associate(FileType type, FileNameMatcher matcher)
void	associateExtension(FileType type, java.lang.String extension) Adds an extension to the list of extensions associated with a file type.
void	associatePattern(FileType type, java.lang.String pattern)
abstract java.lang.String []	getAssociatedExtensions(FileType type) Deprecated. since more generic way of associations using wildcards exist, not every association matches extension paradigm
abstract java.util.List<FileNameMatcher>	getAssociations(FileType type)
abstract 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.
static FileTypeManager	getInstance() Returns the singleton instance of the FileTypeManager component.
FileType	getKnownFileTypeOrAssociate(VirtualFile file) Deprecated. Use getKnownFileTypeOrAssociate(VirtualFile, Project) instead
abstract FileType	getKnownFileTypeOrAssociate(VirtualFile file, Project project)
abstract FileType	getStdFileType(java.lang.String fileTypeName)
abstract boolean	isFileIgnored(java.lang.String name) Checks if the specified file is ignored by the IDE.
static FileNameMatcher	parseFromString(java.lang.String pattern)
abstract void	registerFileType(FileType type, java.util.List<? extends FileNameMatcher> defaultAssociations) Deprecated. use com.intellij.fileType extension point or FileTypeFactory instead
void	registerFileType(FileType type, java.lang.String... defaultAssociatedExtensions) Deprecated. use com.intellij.fileType extension point or FileTypeFactory instead
void	removeAssociatedExtension(FileType type, java.lang.String extension) Removes an extension from the list of extensions associated with a file type.
abstract void	removeAssociation(FileType type, FileNameMatcher matcher)
abstract void	removeFileTypeListener(FileTypeListener listener) Deprecated. Subscribe to TOPIC on any message bus level instead.
abstract void	setIgnoredFilesList(java.lang.String list) Sets new list of semicolon-delimited patterns for files and folders which are excluded from the project structure.

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

findFileTypeByLanguage, findFileTypeByName, getFileTypeByExtension, getFileTypeByFile, getFileTypeByFile, getFileTypeByFileName, getFileTypeByFileName, getRegisteredFileTypes, isFileIgnored, isFileOfType

Methods inherited from class java.lang.Object

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

Field Detail

TOPIC

public static final Topic<FileTypeListener> TOPIC

Constructor Detail

FileTypeManager

public FileTypeManager()

Method Detail

getInstance

public static FileTypeManager getInstance()

Returns the singleton instance of the FileTypeManager component.

Returns:

the instance of FileTypeManager

registerFileType

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

Deprecated. use com.intellij.fileType extension point or FileTypeFactory instead

registerFileType

@Deprecated
public final void registerFileType(FileType type,
                                   java.lang.String... defaultAssociatedExtensions)

Deprecated. use com.intellij.fileType extension point or FileTypeFactory instead

Registers a file type.

Parameters:

type - The file type to register.

defaultAssociatedExtensions - The list of extensions which cause the file to be treated as the specified file type. The extensions should not start with '.'.

isFileIgnored

public abstract boolean isFileIgnored(java.lang.String name)

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.

Parameters:

name - The name of the file to check.

Returns:

true if the file is ignored, false otherwise.

getAssociatedExtensions

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

Deprecated. since more generic way of associations using wildcards exist, not every association matches extension paradigm

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

Parameters:

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

Returns:

The array of extensions associated with the file type.

getAssociations

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

addFileTypeListener

@Deprecated
public abstract void addFileTypeListener(FileTypeListener listener)

Deprecated. Subscribe to TOPIC on any message bus level instead.

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

Parameters:

listener - The listener instance.

removeFileTypeListener

@Deprecated
public abstract void removeFileTypeListener(FileTypeListener listener)

Deprecated. Subscribe to TOPIC on any message bus level instead.

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

Parameters:

listener - The listener instance.

getKnownFileTypeOrAssociate

@Deprecated
public FileType getKnownFileTypeOrAssociate(VirtualFile file)

Deprecated. Use getKnownFileTypeOrAssociate(VirtualFile, Project) instead

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.

Parameters:

file - file to ask for file type association

Returns:

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

getKnownFileTypeOrAssociate

public abstract FileType getKnownFileTypeOrAssociate(VirtualFile file,
                                                     Project project)

getIgnoredFilesList

public abstract 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.

Returns:

Semicolon-delimited list of patterns.

setIgnoredFilesList

public abstract void setIgnoredFilesList(java.lang.String list)

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

Parameters:

list - List of semicolon-delimited patterns.

associateExtension

public final void associateExtension(FileType type,
                                     java.lang.String extension)

Adds an extension to the list of extensions associated with a file type.

Parameters:

type - the file type to associate the extension with.

extension - the extension to associate.

associatePattern

public final void associatePattern(FileType type,
                                   java.lang.String pattern)

associate

public abstract void associate(FileType type,
                               FileNameMatcher matcher)

removeAssociatedExtension

public final void removeAssociatedExtension(FileType type,
                                            java.lang.String extension)

Removes an extension from the list of extensions associated with a file type.

Parameters:

type - the file type to remove the extension from.

extension - the extension to remove.

removeAssociation

public abstract void removeAssociation(FileType type,
                                       FileNameMatcher matcher)

parseFromString

public static FileNameMatcher parseFromString(java.lang.String pattern)

getStdFileType

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