Module Mal4J

Package dev.katsute.mal4j.property

Interface MediaItem<MediaType extends Enum<?>,Status extends Enum<?>,ListStatus extends ListStatus<?>>

Type Parameters:

MediaType - media type enum

Status - status type enum

ListStatus - list status object

All Superinterfaces:

ID

All Known Subinterfaces:

FullMediaItem<MediaType,Status,ListStatus,Recommendation,Statistics>

All Known Implementing Classes:

Anime, AnimePreview, Manga, MangaPreview

public interface MediaItem<MediaType extends Enum<?>,Status extends Enum<?>,ListStatus extends ListStatus<?>>
extends ID

Indicates that the object contains these media fields.

Since:

1.0.0

Version:

3.0.0

Author:

Katsute

See Also:

• FullMediaItem

Method Summary

Modifier and Type	Method	Description
AlternativeTitles	getAlternativeTitles()	Returns the alternative titles.
Date	getCreatedAt()	Returns the creation date.
Long	getCreatedAtEpochMillis()	Returns the creation date as milliseconds since epoch.
NullableDate	getEndDate()	Returns the end date.
Genre[]	getGenres()	Returns the genres.
ListStatus	getListStatus()	Returns the user's list status.
Picture	getMainPicture()	Returns the main picture.
Float	getMeanRating()	Returns the average user rating.
NSFW	getNSFW()	Returns the NSFW rating.
Integer	getPopularity()	Returns the popularity.
Integer	getRank()	Returns the overall rank.
String	getRawNSFW()	Returns the raw NSFW rating.
String	getRawStatus()	Returns the raw status.
String	getRawType()	Returns the raw media type.
NullableDate	getStartDate()	Returns the start date.
Status	getStatus()	Returns the status.
String	getSynopsis()	Returns the synopsis.
String	getTitle()	Returns the title.
MediaType	getType()	Returns the media type.
Date	getUpdatedAt()	Returns when this was last updated.
Long	getUpdatedAtEpochMillis()	Returns when this was last updated as milliseconds since epoch.
Integer	getUserListingCount()	Returns how many users have this item on their list.
Integer	getUserScoringCount()	Returns how many users have this item scored on their list.

Methods inherited from interface dev.katsute.mal4j.property.ID

getID

Method Details

getTitle

String getTitle()

Returns the title.

Returns:

title

Since:

1.0.0

getMainPicture

Picture getMainPicture()

Returns the main picture.

Returns:

main picture

Since:

1.0.0

See Also:

• Picture

getAlternativeTitles

AlternativeTitles getAlternativeTitles()

Returns the alternative titles.

Returns:

alternative titles

Since:

1.0.0

See Also:

• AlternativeTitles

getStartDate

NullableDate getStartDate()

Returns the start date.

Returns:

start date

See Also:

• NullableDate
• getEndDate()

getEndDate

NullableDate getEndDate()

Returns the end date.

Returns:

end date

Since:

1.0.0

See Also:

• NullableDate
• getStartDate()

getSynopsis

String getSynopsis()

Returns the synopsis.

Returns:

synopsis

Since:

1.0.0

getMeanRating

Float getMeanRating()

Returns the average user rating.

Returns:

mean rating

Since:

1.0.0

getRank

Integer getRank()

Returns the overall rank.

Returns:

rank

Since:

1.0.0

getPopularity

Integer getPopularity()

Returns the popularity.

Returns:

popularity

Since:

1.0.0

getUserListingCount

Integer getUserListingCount()

Returns how many users have this item on their list.

Returns:

user list count

Since:

1.0.0

getUserScoringCount

Integer getUserScoringCount()

Returns how many users have this item scored on their list.

Returns:

user scoring count

Since:

1.0.0

getNSFW

NSFW getNSFW()

Returns the NSFW rating.

Returns:

NSFW

Since:

1.0.0

See Also:

• getRawNSFW()
• NSFW

getRawNSFW

String getRawNSFW()

Returns the raw NSFW rating.
It is recommended to use getNSFW() rather than this method. This method should only be used if the NSFW value is missing from NSFW.

Returns:

raw NSFW

Since:

2.9.0

See Also:

• getNSFW()

getGenres

Genre[] getGenres()

Returns the genres.

Returns:

genres

Since:

1.0.0

getCreatedAt

Date getCreatedAt()

Returns the creation date.

Returns:

creation date

Since:

1.0.0

See Also:

• getCreatedAtEpochMillis()
• getUpdatedAt()
• getUpdatedAtEpochMillis()

getCreatedAtEpochMillis

Long getCreatedAtEpochMillis()

Returns the creation date as milliseconds since epoch.

Returns:

creation time

Since:

1.0.0

See Also:

• getCreatedAt()
• getUpdatedAt()
• getUpdatedAt()

getUpdatedAt

Date getUpdatedAt()

Returns when this was last updated.

Returns:

updated time

Since:

1.0.0

See Also:

• getUpdatedAtEpochMillis()
• getCreatedAt()
• getCreatedAtEpochMillis()

getUpdatedAtEpochMillis

Long getUpdatedAtEpochMillis()

Returns when this was last updated as milliseconds since epoch.

Returns:

updated time

Since:

1.0.0

See Also:

• getUpdatedAt()
• getCreatedAt()
• getCreatedAtEpochMillis()

getType

MediaType getType()

Returns the media type.

Returns:

media type

Since:

1.0.0

See Also:

• getRawType()
• AnimeType
• MangaType

getRawType

String getRawType()

Returns the raw media type.
It is recommended to use getType() rather than this method. This method should only be used if the type value is missing from AnimeType or MangaType.

Returns:

raw media type

Since:

2.9.0

See Also:

• getType()

getStatus

Status getStatus()

Returns the status.

Returns:

status

Since:

1.0.0

See Also:

• getRawStatus()
• AnimeAirStatus
• MangaPublishStatus

getRawStatus

String getRawStatus()

Returns the raw status.
It is recommended to use getStatus() rather than this method. This method should only be used if the status is missing from AnimeAirStatus or MangaPublishStatus.

Returns:

raw status

Since:

2.9.0

See Also:

• getStatus()

getListStatus

ListStatus getListStatus()

Returns the user's list status.

Returns:

list status

Since:

1.0.0

See Also:

• AnimeListStatus
• MangaListStatus