be.ceau.itunesapi

Class FeedGenerator

java.lang.Object

be.ceau.itunesapi.FeedGenerator

All Implemented Interfaces:

Serializable

public class FeedGenerator
extends Object
implements Serializable

Request object for the iTunes Feed Generator API.

See Also:

rss.itunes.apple.com, Serialized Form

Constructor Summary

Constructors

Constructor and Description
FeedGenerator()

Method Summary

Modifier and Type	Method and Description
Feed	execute() Queries iTunes using the current state of this FeedGenerator
Feed	execute(Connector connector) Execute this Feed Generator API request using the provided Connector implementation.
Country	getCountry()
FeedType	getFeedType()
FeedFormat	getFormat()
MediaType	getMediaType()
int	getResultsLimit()
String	getUrl() Construct a valid feed URL based on the current state of this FeedGenerator
boolean	isAllowExplicit()
FeedGenerator	setAllowExplicit(boolean allowExplicit) Default value is true
FeedGenerator	setCountry(Country country) Default value is Country.UNITED_STATES
FeedGenerator	setFeedType(FeedType feedType) Default value is FeedType.NEW_MUSIC The given FeedType must be compatible with the current MediaType.
FeedGenerator	setFormat(FeedFormat format) Default value is FeedFormat.JSON
FeedGenerator	setMediaType(MediaType mediaType) Default value is MediaType.APPLE_MUSIC Setting MediaType also changes the FeedType to be compatible with the given MediaType
FeedGenerator	setResultsLimit(int resultsLimit) Default value is 10 Note that Apple limits results to 200, even when more are requested

Methods inherited from class java.lang.Object

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

Constructor Detail

FeedGenerator

public FeedGenerator()

Method Detail

getUrl

public String getUrl()

Construct a valid feed URL based on the current state of this FeedGenerator

Returns:

url as String, never null

execute

public Feed execute()

Queries iTunes using the current state of this FeedGenerator

Returns:

parsed Feed

execute

public Feed execute(Connector connector)

Execute this Feed Generator API request using the provided Connector implementation.

Parameters:

connector - Connector implementation, not null

Returns:

parsed Feed response from iTunes

Throws:

IllegalArgumentException - if argument null

RuntimeException - wrapping any IOException thrown performing the request or parsing the response

getCountry

public Country getCountry()

setCountry

public FeedGenerator setCountry(Country country)

Default value is Country.UNITED_STATES

Parameters:

country - a Country, not null

Returns:

this instance for method chaining

getMediaType

public MediaType getMediaType()

setMediaType

public FeedGenerator setMediaType(MediaType mediaType)

Default value is MediaType.APPLE_MUSIC

Setting MediaType also changes the FeedType to be compatible with the given MediaType

Parameters:

mediaType - a MediaType, not null

Returns:

this instance for method chaining

getFeedType

public FeedType getFeedType()

setFeedType

public FeedGenerator setFeedType(FeedType feedType)

Default value is FeedType.NEW_MUSIC

The given FeedType must be compatible with the current MediaType. Refer to MediaType.getCompatibleFeedTypes() to determine which FeedType instances are compatible with the current MediaType.

Parameters:

feedType - a FeedType, not null

Returns:

this instance for method chaining

See Also:

MediaType.getCompatibleFeedTypes()

getResultsLimit

public int getResultsLimit()

setResultsLimit

public FeedGenerator setResultsLimit(int resultsLimit)

Default value is 10

Note that Apple limits results to 200, even when more are requested

Parameters:

resultsLimit - a positive integer

Returns:

this instance for method chaining

isAllowExplicit

public boolean isAllowExplicit()

setAllowExplicit

public FeedGenerator setAllowExplicit(boolean allowExplicit)

Default value is true

Parameters:

allowExplicit - true if explicit results may be included

Returns:

this instance for method chaining

getFormat

public FeedFormat getFormat()

setFormat

public FeedGenerator setFormat(FeedFormat format)

Default value is FeedFormat.JSON

Parameters:

format - a FeedFormat, not null

Returns:

this instance for method chaining