Package com.intellij.openapi.fileTypes

Class LanguageFileType

java.lang.Object

com.intellij.openapi.fileTypes.LanguageFileType

All Implemented Interfaces:

FileType, Scheme

Direct Known Subclasses:

BuildoutCfgFileType, CommandLineFileType, DTDFileType, GroovyFileType, IgnoreFileType, JavaFileType, JqlFileType, JShellFileType, JsonFileType, JsonSchemaFileType, ManifestFileType, MarkdownFileType, MockLanguageFileType, PlainTextFileType, PropertiesFileType, PythonFileType, QtFileType, RegExpFileType, RestFileType, RncFileType, ScratchFileType, ShFileType, SPIFileType, SubstitutedFileType, TemplateDataElementType.TemplateFileType, TextMateFileType, XmlLikeFileType, XPathFileType, YAMLFileType, YouTrackFileType

public abstract class LanguageFileType
extends java.lang.Object
implements FileType

Kind of file types capable to provide Language. Note that the associated language can still be overridden by a LanguageSubstitutor.

Field Summary

Fields inherited from interface com.intellij.openapi.fileTypes.FileType

EMPTY_ARRAY

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

EDITABLE_COPY_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LanguageFileType(Language language) Creates a language file type for the specified language.
protected	LanguageFileType(Language language, boolean secondary) Creates a language file type for the specified language.

Method Summary

Modifier and Type	Method and Description
java.nio.charset.Charset	extractCharsetFromFileContent(Project project, VirtualFile file, java.lang.CharSequence content)
java.nio.charset.Charset	extractCharsetFromFileContent(Project project, VirtualFile file, java.lang.String content) Deprecated. Callers: use CharsetUtil.extractCharsetFromFileContent(Project, VirtualFile, FileType, CharSequence) Overriders: override extractCharsetFromFileContent(Project, VirtualFile, CharSequence) instead
java.lang.String	getCharset(VirtualFile file, byte [] content) Returns the character set for the specified file.
Language	getLanguage() Returns the language used in the files of the type.
boolean	isBinary() Returns true if files of the specified type contain binary data.
boolean	isJVMDebuggingSupported() Deprecated. implement own JavaDebugAware instead
boolean	isReadOnly() Returns true if the specified file type is read-only.
boolean	isSecondary() If true, this language file type will never be returned as the associated file type for the language.

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.fileTypes.FileType

getDefaultExtension, getDescription, getIcon, getName

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

getDisplayName

Constructor Detail

LanguageFileType

protected LanguageFileType(Language language)

Creates a language file type for the specified language.

Parameters:

language - The language used in the files of the type.

LanguageFileType

protected LanguageFileType(Language language,
                           boolean secondary)

Creates a language file type for the specified language.

Parameters:

language - The language used in the files of the type.

secondary - If true, this language file type will never be returned as the associated file type for the language. (Used when a file type is reusing the language of another file type, e.g. XML).

Method Detail

getLanguage

public final Language getLanguage()

Returns the language used in the files of the type.

Returns:

The language instance.

isBinary

public final boolean isBinary()

Description copied from interface: FileType

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

Specified by:

isBinary in interface FileType

Returns:

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

isReadOnly

public boolean isReadOnly()

Description copied from interface: FileType

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.

Specified by:

isReadOnly in interface FileType

Returns:

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

isSecondary

public boolean isSecondary()

If true, this language file type will never be returned as the associated file type for the language. (Used when a file type is reusing the language of another file type, e.g. XML).

getCharset

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

Description copied from interface: FileType

Returns the character set for the specified file.

Specified by:

getCharset in interface FileType

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.

isJVMDebuggingSupported

@Deprecated
public boolean isJVMDebuggingSupported()

Deprecated. implement own JavaDebugAware instead

extractCharsetFromFileContent

@Deprecated
public java.nio.charset.Charset extractCharsetFromFileContent(Project project,
                                                              VirtualFile file,
                                                              java.lang.String content)

Deprecated. Callers: use CharsetUtil.extractCharsetFromFileContent(Project, VirtualFile, FileType, CharSequence) Overriders: override extractCharsetFromFileContent(Project, VirtualFile, CharSequence) instead

extractCharsetFromFileContent

public java.nio.charset.Charset extractCharsetFromFileContent(Project project,
                                                              VirtualFile file,
                                                              java.lang.CharSequence content)