Package yearreview.app.data.processor.toplist

Interface TopListCompatibleItem

All Known Implementing Classes:
AudioData, AudioPiece, TopListItem
public interface TopListCompatibleItem
Interface for Items that can be displayed in a TopList. TopListItem can be used if no special implementation is needed. A TopListItem contains the data about an Item on the TopList and a TopListElement additionally contains a Value that is displayed alongside and used for sorting.
Author:
ColdStone37

  • Method Summary

    Modifier and Type
    Method
    Description
    ImageReference
    getImage()
    Gets the Image that should be displayed alongside the main and subtext if available.
    String
    getMainText()
    Gets the main text to display on the TopList.
    String
    getSubText()
    Gets the sub text that can provide additional information on the TopList.
    boolean
    hasSubText()
    Gets whether the Item has a subtext.

  • Method Details

    • getMainText

      String getMainText()
      Gets the main text to display on the TopList.
      Returns:
      main text to display

    • getSubText

      String getSubText()
      Gets the sub text that can provide additional information on the TopList.
      Returns:
      sub text to display

    • hasSubText

      boolean hasSubText()
      Gets whether the Item has a subtext.
      Returns:
      true if the item has a subtext

    • getImage

      ImageReference getImage()
      Gets the Image that should be displayed alongside the main and subtext if available.
      Returns:
      Image to display alongside