Package org.opengrok.indexer.analysis

Interface LangMap

All Known Implementing Classes:
LangTreeMap
public interface LangMap
Represents an API for mapping file specifications versus languages and getting the ctags options representation (--langmap-<LANG> or --map-<LANG>) thereof.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(String fileSpec, String ctagsLang)
    Adds the specified mapping of a file specification to a language.
    void
    clear()
    Removes all settings from this map.
    void
    exclude(String fileSpec)
    Exclude the specified mapping of a file specification to any language.
    Map<String,String>
    getAdditions()
    Gets an unmodifiable view of the current additions.
    List<String>
    getCtagsArgs()
    Gets the transformation of the instance's mappings to ctags arguments.
    Set<String>
    getExclusions()
    Gets an unmodifiable view of the current exclusions.
    LangMap
    mergeSecondary(LangMap other)
    Creates a new instance, merging the settings from the current instance overlaying a specified other.
    LangMap
    unmodifiable()
    Gets an unmodifiable view of the current instance.

  • Method Details

    • clear

      void clear()
      Removes all settings from this map.

    • add

      void add(String fileSpec, String ctagsLang)
      Adds the specified mapping of a file specification to a language. Any matching exclusion via exclude(String) is undone.
      Parameters:
      fileSpec - a value starting with a period ('.') to specify a file extension; otherwise specifying a prefix.
      Throws:
      IllegalArgumentException - if fileSpec is null or is an extension (i.e. starting with a period) but contains any other periods, as that is not ctags-compatible

    • exclude

      void exclude(String fileSpec)
      Exclude the specified mapping of a file specification to any language. Any matching addition via add(String, String) is undone.
      Throws:
      IllegalArgumentException - if fileSpec is null

    • getCtagsArgs

      List<String> getCtagsArgs()
      Gets the transformation of the instance's mappings to ctags arguments.

    • mergeSecondary

      LangMap mergeSecondary(LangMap other)
      Creates a new instance, merging the settings from the current instance overlaying a specified other. Additions from the current instance take precedence, and exclusions from the other only take effect if the current instance has no matching addition.
      Parameters:
      other - a defined instance
      Returns:
      a defined instance

    • unmodifiable

      LangMap unmodifiable()
      Gets an unmodifiable view of the current instance.

    • getAdditions

      Map<String,String> getAdditions()
      Gets an unmodifiable view of the current additions.

    • getExclusions

      Set<String> getExclusions()
      Gets an unmodifiable view of the current exclusions.