Interface SnippetProvider


public interface SnippetProvider
Interface providing access to template snippet definitions.
Since:
5.2.180704
  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull String
    getExtract(@Nullable Language language)
    Get the evaluated header snippet presentation for the given language.
    @NotNull String
    getHeader(@Nullable Language language)
    Get the evaluated header snippet presentation for the given language.
    @Nullable Image<?>
    getThumbnail(@Nullable Language language)
    Get the evaluated image for the given language.
  • Method Details

    • getThumbnail

      @Nullable @Nullable Image<?> getThumbnail(@Nullable @Nullable Language language)
      Get the evaluated image for the given language. If null is given as language, the underlying implementation will determine a fitting language to be used.
      Parameters:
      language - the Language to get the Image for, or null.
      Returns:
      An image or null.
      Since:
      5.2.180704
    • getHeader

      @NotNull @NotNull String getHeader(@Nullable @Nullable Language language)
      Get the evaluated header snippet presentation for the given language. If null is given as language, the underlying implementation will determine a fitting language to be used.
      Parameters:
      language - the Language to get the Media for, or null.
      Returns:
      header or an empty String
      Since:
      5.2.180704
    • getExtract

      @NotNull @NotNull String getExtract(@Nullable @Nullable Language language)
      Get the evaluated header snippet presentation for the given language. If null is given as language, the underlying implementation will determine a fitting language to be used.
      Parameters:
      language - the Language to get the Media for null.
      Returns:
      extract or an empty String
      Since:
      5.2.180704