Package com.intellij.openapi.fileTypes

Interface FileType

All Superinterfaces:

Scheme

All Known Subinterfaces:

CustomSyntaxTableFileType, DirectoryFileType, FileTypeIdentifiableByVirtualFile, INativeFileType, InternalFileType, UIBasedFileType

All Known Implementing Classes:

AbstractFileType, ArchiveFileType, BuildoutCfgFileType, CommandLineFileType, DictionaryFileType, DTDFileType, EclipseFileType, EnforcedPlainTextFileType, FakeFileType, GitExcludeFileType, GitIgnoreFileType, GroovyFileType, GuiFormFileType, HgIgnoreFileType, HtmlFileType, IgnoreFileType, ImageFileType, JavaClassFileType, JavaFileType, JqlFileType, JShellFileType, Json5FileType, JsonFileType, JsonSchemaFileType, LanguageFileType, ManifestFileType, MarkdownFileType, MockLanguageFileType, ModuleFileType, NativeFileType, PatchFileType, PlainTextFileType, ProjectFileType, PropertiesFileType, PyDocstringFileType, PyFunctionTypeAnnotationFileType, PyiFileType, PythonFileType, QtFileType, QtUIFileType, RegExpFileType, ResourceBundleFileType, RestFileType, RncFileType, ScratchFileType, ShFileType, SPIFileType, SubstitutedFileType, SvgFileType, TemplateDataElementType.TemplateFileType, TerminalSessionFileType, TextMateFileType, UiScriptFileType, UnknownFileType, UserBinaryFileType, UserFileType, WorkspaceFileType, XHtmlFileType, XmlFileType, XmlLikeFileType, XPathFileType, YAMLFileType, YouTrackFileType

public interface FileType
extends Scheme

Describes a filetype.

Must be registered via com.intellij.fileType extension point or FileTypeFactory. If file type depends on given file, FileTypeIdentifiableByVirtualFile can be used for non-static mapping.

Use LanguageFileType for files having Language support.

See Also:

StdFileTypes, FileTypes, INativeFileType

Field Summary

Fields

Modifier and Type	Field and Description
static FileType[]	EMPTY_ARRAY

Fields inherited from interface com.intellij.openapi.options.Scheme

EDITABLE_COPY_PREFIX

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCharset(VirtualFile file, byte [] content) Returns the character set for the specified file.
java.lang.String	getDefaultExtension() Returns the default extension for files of the type.
java.lang.String	getDescription() Returns the user-readable description of the file type.
javax.swing.Icon	getIcon() Returns the icon used for showing files of the type.
java.lang.String	getName() Returns the name of the file type.
boolean	isBinary() Returns true if files of the specified type contain binary data.
boolean	isReadOnly() Returns true if the specified file type is read-only.

Methods inherited from interface com.intellij.openapi.options.Scheme

getDisplayName

Field Detail

EMPTY_ARRAY

static final FileType[] EMPTY_ARRAY

Method Detail

getName

java.lang.String getName()

Returns the name of the file type. The name must be unique among all file types registered in the system.

Specified by:

getName in interface Scheme

Returns:

The file type name.

getDescription

java.lang.String getDescription()

Returns the user-readable description of the file type.

Returns:

The file type description.

getDefaultExtension

java.lang.String getDefaultExtension()

Returns the default extension for files of the type.

Returns:

The extension, not including the leading '.'.

getIcon

javax.swing.Icon getIcon()

Returns the icon used for showing files of the type.

Returns:

The icon instance, or null if no icon should be shown.

isBinary

boolean isBinary()

Returns true if files of the specified type contain binary data. Used for source control, to-do items scanning and other purposes.

Returns:

true if the file is binary, false if the file is plain text.

isReadOnly

boolean isReadOnly()

Returns true if the specified file type is read-only. Read-only file types are not shown in the "File Types" settings dialog, and users cannot change the extensions associated with the file type.

Returns:

true if the file type is read-only, false otherwise.

getCharset

java.lang.String getCharset(VirtualFile file,
                            byte [] content)

Returns the character set for the specified file.

Parameters:

file - The file for which the character set is requested.

content - File content.

Returns:

The character set name, in the format supported by Charset class.