Package com.intellij.openapi.fileTypes

Interface FileTypeRegistry.FileTypeDetector

Enclosing class:

FileTypeRegistry

public static interface FileTypeRegistry.FileTypeDetector

Pluggable file type detector by content

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<FileTypeRegistry.FileTypeDetector>	EP_NAME

Method Summary

Modifier and Type	Method and Description
FileType	detect(VirtualFile file, ByteSequence firstBytes, java.lang.CharSequence firstCharsIfText) Detects file type by its (may be binary) content on disk.
default int	getDesiredContentPrefixLength() Defines how much content is required for this detector to detect file type reliably.
default java.util.Collection<? extends FileType>	getDetectedFileTypes() Deprecated. unused
int	getVersion()

Field Detail

EP_NAME

static final ExtensionPointName<FileTypeRegistry.FileTypeDetector> EP_NAME

Method Detail

detect

FileType detect(VirtualFile file,
                ByteSequence firstBytes,
                java.lang.CharSequence firstCharsIfText)

Detects file type by its (may be binary) content on disk. Your detector must be as light as possible. In particular, it must not perform any heavy processing, e.g. PSI access, indices, Documents etc. The detector must refrain from throwing exceptions (including pervasive ProcessCanceledException)

Parameters:

file - to analyze

firstBytes - of the file for identifying its file type

firstCharsIfText - - characters, converted from first bytes parameter if the file content was determined to be text, or null otherwise

Returns:

detected file type, or null if was unable to detect

getDetectedFileTypes

@Deprecated
default java.util.Collection<? extends FileType> getDetectedFileTypes()

Deprecated. unused

Returns the file type that this detector is capable of detecting, or null if it can detect multiple file types.

getDesiredContentPrefixLength

default int getDesiredContentPrefixLength()

Defines how much content is required for this detector to detect file type reliably. At least such amount of bytes will be passed to detect(VirtualFile, ByteSequence, CharSequence) if present.

Returns:

number of first bytes to be given

getVersion

int getVersion()