Package org.contextmapper.dsl.hover.impl

Class AbstractCMLHoverTextProvider

java.lang.Object
org.contextmapper.dsl.hover.impl.AbstractCMLHoverTextProvider
All Implemented Interfaces:
CMLHoverTextProvider
Direct Known Subclasses:
HTMLHoverTextProvider4CML, MarkdownHoverTextProvider4CML
public abstract class AbstractCMLHoverTextProvider extends Object implements CMLHoverTextProvider

  • Constructor Details

    • AbstractCMLHoverTextProvider

      public AbstractCMLHoverTextProvider()

  • Method Details

    • getHoverText

      public String getHoverText(String keyword)
      Description copied from interface: CMLHoverTextProvider
      Returns the hover text for a specific CML keyword.
      Specified by:
      getHoverText in interface CMLHoverTextProvider
      Parameters:
      keyword - the keyword for which the hover text shall be returned
      Returns:
      the hover text for the given keyword

    • isKeywordRegistered

      public boolean isKeywordRegistered(String keyword)
      Description copied from interface: CMLHoverTextProvider
      Returns whether the provider can give a hover text for a specific keyword or not.
      Specified by:
      isKeywordRegistered in interface CMLHoverTextProvider
      Parameters:
      keyword - the keyword for which a hover text is asked
      Returns:
      whether the keyword is registered or not

    • registerHoverTexts

      protected abstract void registerHoverTexts()
      Override this method to register hover texts.

    • registerHoverText

      protected void registerHoverText(String keyword, String hoverText)