Interface ILanguageSettingsProvider

    • Method Detail

      • getId

        String getId()
        Id is used to keep track of the providers internally. Use unique id to represent the provider.
        Returns:
        Id of the provider.
      • getName

        String getName()
        Name is used to present the provider to the end user in UI.
        Returns:
        name of the provider.
      • getSettingEntries

        List<ICLanguageSettingEntry> getSettingEntries​(ICConfigurationDescription cfgDescription,
                                                       org.eclipse.core.resources.IResource rc,
                                                       String languageId)
        Returns the list of setting entries for the given configuration description, resource and language.

        Note to implementers - this method should not be used to do any long running operations such as extensive calculations or reading files. If you need to do so, the recommended way is to do the calculations outside of this function call - in advance and on appropriate event. For example, Build Output Parser prepares the list and stores it in internal cache while parsing output. getSettingEntries(ICConfigurationDescription, IResource, String) will return cached entries when asked. You can also implement ICListenerAgent interface to get registered and listen to arbitrary events.
        Parameters:
        cfgDescription - - configuration description.
        rc - - resource such as file or folder. If null, the default entries for all resources are returned.
        languageId - - language id. If null, the default entries for all languages are returned. (see LanguageManager.getLanguageForFile(org.eclipse.core.resources.IFile, ICConfigurationDescription)).
        Returns:
        the list of setting entries or null if no settings defined. The list needs to be a pooled list created by LanguageSettingsStorage.getPooledList(List) to save memory and avoid deep equality comparisons.