Package com.intellij.lang

Class Language

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.lang.Language

All Implemented Interfaces:

UserDataHolder, UserDataHolderEx

Direct Known Subclasses:

BuildoutCfgLanguage, CommandLineLanguage, CompositeLanguage, EcmaScriptRegexpLanguage, EcmaScriptUnicodeRegexpLanguage, IgnoreLanguage, JavaLanguage, JqlLanguage, JShellLanguage, JsonLanguage, JspxFileViewProvider.JavaHolderMethodTreeLanguage, ManifestLanguage, MarkdownLanguage, MetaLanguage, PlainTextLanguage, PlantUMLLanguage, PropertiesLanguage, PyDocstringLanguageDialect, PyFunctionTypeAnnotationDialect, PyiLanguageDialect, PythonLanguage, PythonRegexpLanguage, PythonVerboseRegexpLanguage, RegExpLanguage, RestLanguage, RngCompactLanguage, ShLanguage, SPILanguage, TextMateLanguage, XPath2Language, XPathLanguage, XsltLanguage, YAMLLanguage, YouTrackLanguage

public abstract class Language
extends UserDataHolderBase

The base class for all programming language support implementations. Specific language implementations should inherit from this class and its registered instance wrapped with LanguageFileType via com.intellij.fileType extension point. There should be exactly one instance of each Language. It is usually created when creating LanguageFileType and can be retrieved later with findInstance(Class). For the list of standard languages, see StdLanguages.

The language coming from file type can be changed by LanguageSubstitutor.

Field Summary

Fields

Modifier and Type	Field and Description
static Language	ANY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Language(Language baseLanguage, java.lang.String ID, java.lang.String... mimeTypes)
protected	Language(java.lang.String ID)
protected	Language(java.lang.String ID, boolean register) Fake language identifier without registering
protected	Language(java.lang.String ID, java.lang.String... mimeTypes)

Method Summary

Modifier and Type	Method and Description
static <T extends Language> T	findInstance(java.lang.Class<T> klass)
static java.util.Collection<Language>	findInstancesByMimeType(java.lang.String mimeType)
static Language	findLanguageByID(java.lang.String id)
LanguageFileType	findMyFileType(FileType[] types)
LanguageFileType	getAssociatedFileType()
Language	getBaseLanguage()
java.util.List<Language>	getDialects()
java.lang.String	getDisplayName()
java.lang.String	getID() Returns a user-readable name of the language.
java.lang.String []	getMimeTypes() Returns the list of MIME types corresponding to the language.
static java.util.Collection<Language>	getRegisteredLanguages()
boolean	is(Language another)
boolean	isCaseSensitive()
boolean	isKindOf(Language another)
boolean	isKindOf(java.lang.String anotherLanguageId)
java.lang.String	toString()
void	unregisterDialect(Language language)
static void	unregisterLanguage(Language language)
static void	unregisterLanguages(java.lang.ClassLoader classLoader)

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

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

Field Detail

ANY

public static final Language ANY

Constructor Detail

Language

protected Language(java.lang.String ID)

Language

protected Language(java.lang.String ID,
                   java.lang.String... mimeTypes)

Language

protected Language(Language baseLanguage,
                   java.lang.String ID,
                   java.lang.String... mimeTypes)

Language

protected Language(java.lang.String ID,
                   boolean register)

Fake language identifier without registering

Method Detail

getRegisteredLanguages

public static java.util.Collection<Language> getRegisteredLanguages()

Returns:

collection of all languages registered so far.

unregisterLanguages

public static void unregisterLanguages(java.lang.ClassLoader classLoader)

unregisterLanguage

public static void unregisterLanguage(Language language)

unregisterDialect

public void unregisterDialect(Language language)

findInstance

public static <T extends Language> T findInstance(java.lang.Class<T> klass)

Parameters:

klass - java.lang.Class of the particular language. Serves key purpose.

Returns:

instance of the klass language registered if any.

findInstancesByMimeType

public static java.util.Collection<Language> findInstancesByMimeType(java.lang.String mimeType)

Parameters:

mimeType - of the particular language.

Returns:

collection of all languages for the given mimeType.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getMimeTypes

public java.lang.String [] getMimeTypes()

Returns the list of MIME types corresponding to the language. The language MIME type is used for specifying the base language of a JSP page.

Returns:

The list of MIME types.

getID

public java.lang.String getID()

Returns a user-readable name of the language.

Returns:

the name of the language.

getAssociatedFileType

public LanguageFileType getAssociatedFileType()

findMyFileType

public LanguageFileType findMyFileType(FileType[] types)

getBaseLanguage

public Language getBaseLanguage()

getDisplayName

public java.lang.String getDisplayName()

is

public final boolean is(Language another)

isCaseSensitive

public boolean isCaseSensitive()

Returns:

whether identifiers in this language are case-sensitive. By default, delegates to the base language (if present) or returns false (otherwise).

isKindOf

public final boolean isKindOf(Language another)

isKindOf

public final boolean isKindOf(java.lang.String anotherLanguageId)

getDialects

public java.util.List<Language> getDialects()

findLanguageByID

public static Language findLanguageByID(java.lang.String id)