Package yearreview.app.data.processor.toplist

Class TopListItem

java.lang.Object

yearreview.app.data.processor.toplist.TopListItem

All Implemented Interfaces:

TopListCompatibleItem

public class TopListItem
extends Object
implements TopListCompatibleItem

Basic Implementation of TopListCompatibleItem that can be used if no special functionality is needed.

Author:

ColdStone37

Field Summary

Fields

Modifier and Type	Field	Description
private final ImageReference	img	Image to display alongside the item.
private final String	mainText	Main text to display for the item.
private final String	subText	Sub text to display for the item.

Constructor Summary

Constructors

Constructor	Description
TopListItem(String main)	Constructs a TopListItem with only main text given
TopListItem(String main, String sub)	Constructs a TopListItem with only text given
TopListItem(String main, String sub, ImageReference img)	Constructs a TopListItem from all Values.

Method Summary

Modifier and Type	Method	Description
ImageReference	getImage()	Gets the Image that should be displayed alongside the data.
String	getMainText()	Gets the main text.
String	getSubText()	Gets the sub text.
boolean	hasSubText()	Gets whether the item has a sub text.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

mainText

private final String mainText

Main text to display for the item.

subText

private final String subText

Sub text to display for the item.

img

private final ImageReference img

Image to display alongside the item.

Constructor Details

TopListItem

public TopListItem(String main,
 String sub,
 ImageReference img)

Constructs a TopListItem from all Values.

Parameters:

main - main text to display

sub - sub text to display

img - image to display alongside

TopListItem

public TopListItem(String main,
 String sub)

Constructs a TopListItem with only text given

Parameters:

main - main text to display

sub - sub text to display

TopListItem

public TopListItem(String main)

Constructs a TopListItem with only main text given

Parameters:

main - main text to display

Method Details

getMainText

public String getMainText()

Gets the main text.

Specified by:

getMainText in interface TopListCompatibleItem

Returns:

main text

getSubText

public String getSubText()

Gets the sub text. Value Does not necessarily need to be set (Can be checked using the hasSubText()-function).

Specified by:

getSubText in interface TopListCompatibleItem

Returns:

sub text

hasSubText

public boolean hasSubText()

Gets whether the item has a sub text.

Specified by:

hasSubText in interface TopListCompatibleItem

Returns:

true if subText != null, false otherwise

getImage

public ImageReference getImage()

Gets the Image that should be displayed alongside the data. Might be null if it was not set.

Specified by:

getImage in interface TopListCompatibleItem

Returns:

Reference to Image