org.tinymediamanager.scraper.entities

Class MediaArtwork

java.lang.Object

org.tinymediamanager.scraper.entities.MediaArtwork

public class MediaArtwork
extends Object

This class is used to represent an artwork for a media

Since:

1.0

Author:

Manuel Laggner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MediaArtwork.FanartSizes All available fanart sizes
static class	MediaArtwork.ImageSizeAndUrl This class represents a combination of image size and the correspondin url for an artwork
static class	MediaArtwork.MediaArtworkComparator
static class	MediaArtwork.MediaArtworkType The different types of artwork we know
static class	MediaArtwork.PosterSizes All available poster sizes

Constructor Summary

Constructors

Constructor and Description
MediaArtwork(MediaArtwork oldArtwork, MediaArtwork.MediaArtworkType type) A copy constructor for MediaArtwork - to clone an existing one for a new type
MediaArtwork(String providerId, MediaArtwork.MediaArtworkType type) Create a new instance of MediaArtwork for the given provider and type

Method Summary

Methods

Modifier and Type	Method and Description
void	addImageSize(int width, int height, String url) Add an image size.
MediaArtwork.ImageSizeAndUrl	getBiggestArtwork() Get the biggest artwork if different sizes are available or null
String	getDefaultUrl() Get the default url for this artwork
List<MediaArtwork.ImageSizeAndUrl>	getImageSizes() Get all available image sizes for this artwork
String	getImdbId() Get the assigned IMDB id for this artwork
String	getLanguage() Get the language for this artwork if available
int	getLikes() Get the likes of this artwork to indicate how popular this artwork is
String	getPreviewUrl() Get a preview url or the default url if no preview url is available
String	getProviderId() Get the provider id
int	getSeason() Get the season (useful for season artwork)
int	getSizeOrder() Get the size order to indicate how big this artwork is
MediaArtwork.ImageSizeAndUrl	getSmallestArtwork() Get the smallest artwork if different sizes are available or null
int	getTmdbId() Get the assigned TMDB id for this artwork
MediaArtwork.MediaArtworkType	getType() Get the artwork type
void	setDefaultUrl(String defaultUrl) Set the default url
void	setImdbId(String imdbId) Set the assigned IMDB id for this artwork
void	setLanguage(String language) Set the language for this artwork
void	setLikes(int likes) amount of likes (or other, for ordering)
void	setPreviewUrl(String previewUrl) Set the preview url
void	setSeason(int season) Set the season (useful for season artwork)
void	setSizeOrder(int sizeOrder) Set the size order to indicate how big this artwork is
void	setTmdbId(int tmdbId) Set the assigned TMDB id for this artwork
String	toString() Uses ReflectionToStringBuilder to generate a toString for the specified object.

Methods inherited from class java.lang.Object

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

Constructor Detail

MediaArtwork

public MediaArtwork(String providerId,
            MediaArtwork.MediaArtworkType type)

Create a new instance of MediaArtwork for the given provider and type

Parameters:

providerId - the provider id

type - the artwork type

MediaArtwork

public MediaArtwork(MediaArtwork oldArtwork,
            MediaArtwork.MediaArtworkType type)

A copy constructor for MediaArtwork - to clone an existing one for a new type

Parameters:

oldArtwork - the instance to copy

type - the new type

Method Detail

getPreviewUrl

public String getPreviewUrl()

Get a preview url or the default url if no preview url is available

Returns:

the preview url or the default url

setPreviewUrl

public void setPreviewUrl(String previewUrl)

Set the preview url

Parameters:

previewUrl - the preview url

getDefaultUrl

public String getDefaultUrl()

Get the default url for this artwork

Returns:

the default url

setDefaultUrl

public void setDefaultUrl(String defaultUrl)

Set the default url

Parameters:

defaultUrl - the default url

getProviderId

public String getProviderId()

Get the provider id

Returns:

the provider id

getType

public MediaArtwork.MediaArtworkType getType()

Get the artwork type

Returns:

the artwork type

getLanguage

public String getLanguage()

Get the language for this artwork if available

Returns:

the language for this artwork

setLanguage

public void setLanguage(String language)

Set the language for this artwork

Parameters:

language - the language

getTmdbId

public int getTmdbId()

Get the assigned TMDB id for this artwork

Returns:

the tmdb id

setTmdbId

public void setTmdbId(int tmdbId)

Set the assigned TMDB id for this artwork

Parameters:

tmdbId - the tmdb id

getImdbId

public String getImdbId()

Get the assigned IMDB id for this artwork

Returns:

the imdb id

setImdbId

public void setImdbId(String imdbId)

Set the assigned IMDB id for this artwork

Parameters:

imdbId - the imdb id

addImageSize

public void addImageSize(int width,
                int height,
                String url)

Add an image size. This is used for the image chooser to show the user the different sizes for this artwork

Parameters:

width - thw width

height - the height

url - the url

getImageSizes

public List<MediaArtwork.ImageSizeAndUrl> getImageSizes()

Get all available image sizes for this artwork

Returns:

a list of all available image sizes

getSmallestArtwork

public MediaArtwork.ImageSizeAndUrl getSmallestArtwork()

Get the smallest artwork if different sizes are available or null

Returns:

the smallest artwork or null

getBiggestArtwork

public MediaArtwork.ImageSizeAndUrl getBiggestArtwork()

Get the biggest artwork if different sizes are available or null

Returns:

the biggest artwork or null

getSizeOrder

public int getSizeOrder()

Get the size order to indicate how big this artwork is

Returns:

the size order

setSizeOrder

public void setSizeOrder(int sizeOrder)

Set the size order to indicate how big this artwork is

Parameters:

sizeOrder - the size order

getLikes

public int getLikes()

Get the likes of this artwork to indicate how popular this artwork is

Returns:

the likes

setLikes

public void setLikes(int likes)

amount of likes (or other, for ordering)

Parameters:

likes - set the amount of likes

getSeason

public int getSeason()

Get the season (useful for season artwork)

Returns:

the season

setSeason

public void setSeason(int season)

Set the season (useful for season artwork)

Parameters:

season - the season

toString

public String toString()

Uses ReflectionToStringBuilder to generate a toString for the specified object.

Overrides:

toString in class Object

Returns:

the String result

See Also:

ReflectionToStringBuilder.toString(Object)