Package org.contextmapper.dsl.hover

Interface CMLHoverTextProvider

All Known Implementing Classes:
AbstractCMLHoverTextProvider, HTMLHoverTextProvider4CML, MarkdownHoverTextProvider4CML
public interface CMLHoverTextProvider
Implementations of this interface provide hover texts for CML language keywords.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getHoverText(String keyword)
    Returns the hover text for a specific CML keyword.
    boolean
    isKeywordRegistered(String keyword)
    Returns whether the provider can give a hover text for a specific keyword or not.

  • Method Details

    • getHoverText

      String getHoverText(String keyword)
      Returns the hover text for a specific CML keyword.
      Parameters:
      keyword - the keyword for which the hover text shall be returned
      Returns:
      the hover text for the given keyword

    • isKeywordRegistered

      boolean isKeywordRegistered(String keyword)
      Returns whether the provider can give a hover text for a specific keyword or not.
      Parameters:
      keyword - the keyword for which a hover text is asked
      Returns:
      whether the keyword is registered or not