AbstractCMLHoverTextProvider (context-mapper-dsl 6.0.0 API)

java.lang.Object
- org.contextmapper.dsl.hover.impl.AbstractCMLHoverTextProvider

All Implemented Interfaces:

CMLHoverTextProvider

Direct Known Subclasses:

HTMLHoverTextProvider4CML, MarkdownHoverTextProvider4CML
```
public abstract class AbstractCMLHoverTextProvider
extends java.lang.Object
implements CMLHoverTextProvider
```

Constructor Summary

Constructors
Constructor Description

AbstractCMLHoverTextProvider()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getHoverText(java.lang.String keyword)`	Returns the hover text for a specific CML keyword.
`boolean`	`isKeywordRegistered(java.lang.String keyword)`	Returns whether the provider can give a hover text for a specific keyword or not.
`protected void`	`registerHoverText(java.lang.String keyword, java.lang.String hoverText)`
`protected abstract void`	`registerHoverTexts()`	Override this method to register hover texts.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractCMLHoverTextProvider
```
public AbstractCMLHoverTextProvider()
```
- Method Detail
  - getHoverText
```
public java.lang.String getHoverText(java.lang.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(java.lang.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(java.lang.String keyword,
                                 java.lang.String hoverText)
```