fm.audiobox.core.models

Class Playlists

java.lang.Object

java.util.Observable

fm.audiobox.core.models.Model

fm.audiobox.core.models.Playlists

public class Playlists
extends Model

Used to get a list of all the playlist in the user's account.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PLAYLIST_BOX The constant that identifies the "box" playlist.
static java.lang.String	PLAYLIST_CLOUD The constant that identifies the "cloud" playlist.
static java.lang.String	PLAYLIST_CUSTOM The constant that identifies "custom" playlists.
static java.lang.String	PLAYLIST_DROPBOX The constant that identifies the "dropbox" playlist.
static java.lang.String	PLAYLIST_GDRIVE The constant that identifies the "gdrive" playlist.
static java.lang.String	PLAYLIST_LOCAL The constant that identifies the "local" playlist.
static java.lang.String	PLAYLIST_MEGA The constant that identifies the "mega" playlist.
static java.lang.String	PLAYLIST_OFFLINE The constant that identifies the "offline" playlist.
static java.lang.String	PLAYLIST_ONERIVE The constant that identifies the "onedrive" playlist.
static java.lang.String	PLAYLIST_SMART The constant that identifies "smart" playlists.
static java.lang.String	PLAYLIST_SOUNDCLOUD The constant that identifies the "soundcloud" playlist.
static java.lang.String	PLAYLIST_YOUTUBE The constant that identifies the "youtube" playlist.

Constructor Summary

Constructors

Constructor and Description
Playlists()

Method Summary

Methods

Modifier and Type	Method and Description
static Playlist	getBoxPlaylist(AudioBoxClient audioBoxClient) Gets the box playlist.
static Playlist	getCloudPlaylist(AudioBoxClient audioBoxClient) Gets the cloud playlist.
static Playlist	getDropboxPlaylist(AudioBoxClient audioBoxClient) Gets the dropbox playlist.
static Playlist	getGdrivePlaylist(AudioBoxClient audioBoxClient) Gets the gdrive playlist.
static Playlist	getLocalPlaylist(AudioBoxClient audioBoxClient) Gets the local playlist.
static Playlist	getMegaPlaylist(AudioBoxClient audioBoxClient) Gets the mega playlist .
static Playlist	getOfflinePlaylist(AudioBoxClient audioBoxClient) Gets the offline playlist.
static Playlist	getOneDrivePlaylist(AudioBoxClient audioBoxClient) Gets the skydrive playlist.
static java.lang.String	getPath() Gets the generic remote resource collection path.
java.util.List<Playlist>	getPlaylists() Gets playlists.
static Playlist	getSoundcloudPlaylist(AudioBoxClient audioBoxClient) Gets the soundcloud playlist.
static Playlist	getYoutubePlaylist(AudioBoxClient audioBoxClient) Gets the youtube playlist.

Methods inherited from class fm.audiobox.core.models.Model

getProp, notifyObservers, setProp

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Field Detail

PLAYLIST_LOCAL

public static final java.lang.String PLAYLIST_LOCAL

The constant that identifies the "local" playlist.

See Also:

Constant Field Values

PLAYLIST_CLOUD

public static final java.lang.String PLAYLIST_CLOUD

The constant that identifies the "cloud" playlist.

See Also:

Constant Field Values

PLAYLIST_DROPBOX

public static final java.lang.String PLAYLIST_DROPBOX

The constant that identifies the "dropbox" playlist.

See Also:

Constant Field Values

PLAYLIST_ONERIVE

public static final java.lang.String PLAYLIST_ONERIVE

The constant that identifies the "onedrive" playlist.

See Also:

Constant Field Values

PLAYLIST_BOX

public static final java.lang.String PLAYLIST_BOX

The constant that identifies the "box" playlist.

See Also:

Constant Field Values

PLAYLIST_GDRIVE

public static final java.lang.String PLAYLIST_GDRIVE

The constant that identifies the "gdrive" playlist.

See Also:

Constant Field Values

PLAYLIST_YOUTUBE

public static final java.lang.String PLAYLIST_YOUTUBE

The constant that identifies the "youtube" playlist.

See Also:

Constant Field Values

PLAYLIST_SOUNDCLOUD

public static final java.lang.String PLAYLIST_SOUNDCLOUD

The constant that identifies the "soundcloud" playlist.

See Also:

Constant Field Values

PLAYLIST_MEGA

public static final java.lang.String PLAYLIST_MEGA

The constant that identifies the "mega" playlist.

See Also:

Constant Field Values

PLAYLIST_OFFLINE

public static final java.lang.String PLAYLIST_OFFLINE

The constant that identifies the "offline" playlist.

See Also:

Constant Field Values

PLAYLIST_CUSTOM

public static final java.lang.String PLAYLIST_CUSTOM

The constant that identifies "custom" playlists.

See Also:

Constant Field Values

PLAYLIST_SMART

public static final java.lang.String PLAYLIST_SMART

The constant that identifies "smart" playlists.

See Also:

Constant Field Values

Constructor Detail

Playlists

public Playlists()

Method Detail

getPath

public static java.lang.String getPath()

Gets the generic remote resource collection path.

Returns:

the path

getPlaylists

public java.util.List<Playlist> getPlaylists()

Gets playlists.

Returns:

the playlists collection.

getLocalPlaylist

public static Playlist getLocalPlaylist(AudioBoxClient audioBoxClient)
                                 throws java.io.IOException

Gets the local playlist.

NOTE: this method will always make a request against AudioBox, use carefully. If you want to avoid this behavior consider storing the playlist collection within your application and use ModelUtil.findPlaylistByType(java.util.List, String) in combination with the Playlists#PLAYLIST_* constants to get the right playlist from the memory.

Parameters:

audioBoxClient - the AudioBoxClient to use to make the request

Returns:

the local playlist

Throws:

AudioBoxException - if any of the remote error exception is detected.

java.io.IOException - if any connection problem occurs.

See Also:

AudioBoxException

getCloudPlaylist

public static Playlist getCloudPlaylist(AudioBoxClient audioBoxClient)
                                 throws java.io.IOException

Gets the cloud playlist.

NOTE: this method will always make a request against AudioBox, use carefully. If you want to avoid this behavior consider storing the playlist collection within your application and use ModelUtil.findPlaylistByType(java.util.List, String) in combination with the Playlists#PLAYLIST_* constants to get the right playlist from the memory.

Parameters:

audioBoxClient - the AudioBoxClient to use to make the request

Returns:

the cloud playlist

Throws:

AudioBoxException - if any of the remote error exception is detected.

java.io.IOException - if any connection problem occurs.

See Also:

AudioBoxException

getDropboxPlaylist

public static Playlist getDropboxPlaylist(AudioBoxClient audioBoxClient)
                                   throws java.io.IOException

Gets the dropbox playlist.

NOTE: this method will always make a request against AudioBox, use carefully. If you want to avoid this behavior consider storing the playlist collection within your application and use ModelUtil.findPlaylistByType(java.util.List, String) in combination with the Playlists#PLAYLIST_* constants to get the right playlist from the memory.

Parameters:

audioBoxClient - the AudioBoxClient to use to make the request

Returns:

the dropbox playlist

Throws:

AudioBoxException - if any of the remote error exception is detected.

java.io.IOException - if any connection problem occurs.

See Also:

AudioBoxException

getOneDrivePlaylist

public static Playlist getOneDrivePlaylist(AudioBoxClient audioBoxClient)
                                    throws java.io.IOException

Gets the skydrive playlist.

NOTE: this method will always make a request against AudioBox, use carefully. If you want to avoid this behavior consider storing the playlist collection within your application and use ModelUtil.findPlaylistByType(java.util.List, String) in combination with the Playlists#PLAYLIST_* constants to get the right playlist from the memory.

Parameters:

audioBoxClient - the AudioBoxClient to use to make the request

Returns:

the one drive playlist

Throws:

AudioBoxException - if any of the remote error exception is detected.

java.io.IOException - if any connection problem occurs.

See Also:

AudioBoxException

getBoxPlaylist

public static Playlist getBoxPlaylist(AudioBoxClient audioBoxClient)
                               throws java.io.IOException

Gets the box playlist.

NOTE: this method will always make a request against AudioBox, use carefully. If you want to avoid this behavior consider storing the playlist collection within your application and use ModelUtil.findPlaylistByType(java.util.List, String) in combination with the Playlists#PLAYLIST_* constants to get the right playlist from the memory.

Parameters:

audioBoxClient - the AudioBoxClient to use to make the request

Returns:

the box playlist

Throws:

AudioBoxException - if any of the remote error exception is detected.

java.io.IOException - if any connection problem occurs.

See Also:

AudioBoxException

getGdrivePlaylist

public static Playlist getGdrivePlaylist(AudioBoxClient audioBoxClient)
                                  throws java.io.IOException

Gets the gdrive playlist.

NOTE: this method will always make a request against AudioBox, use carefully. If you want to avoid this behavior consider storing the playlist collection within your application and use ModelUtil.findPlaylistByType(java.util.List, String) in combination with the Playlists#PLAYLIST_* constants to get the right playlist from the memory.

Parameters:

audioBoxClient - the AudioBoxClient to use to make the request

Returns:

the google drive playlist

Throws:

AudioBoxException - if any of the remote error exception is detected.

java.io.IOException - if any connection problem occurs.

See Also:

AudioBoxException

getYoutubePlaylist

public static Playlist getYoutubePlaylist(AudioBoxClient audioBoxClient)
                                   throws java.io.IOException

Gets the youtube playlist.

NOTE: this method will always make a request against AudioBox, use carefully. If you want to avoid this behavior consider storing the playlist collection within your application and use ModelUtil.findPlaylistByType(java.util.List, String) in combination with the Playlists#PLAYLIST_* constants to get the right playlist from the memory.

Parameters:

audioBoxClient - the AudioBoxClient to use to make the request

Returns:

the youtube playlist

Throws:

AudioBoxException - if any of the remote error exception is detected.

java.io.IOException - if any connection problem occurs.

See Also:

AudioBoxException

getSoundcloudPlaylist

public static Playlist getSoundcloudPlaylist(AudioBoxClient audioBoxClient)
                                      throws java.io.IOException

Gets the soundcloud playlist.

NOTE: this method will always make a request against AudioBox, use carefully. If you want to avoid this behavior consider storing the playlist collection within your application and use ModelUtil.findPlaylistByType(java.util.List, String) in combination with the Playlists#PLAYLIST_* constants to get the right playlist from the memory.

Parameters:

audioBoxClient - the AudioBoxClient to use to make the request

Returns:

the soundcloud playlist

Throws:

AudioBoxException - if any of the remote error exception is detected.

java.io.IOException - if any connection problem occurs.

See Also:

AudioBoxException

getMegaPlaylist

public static Playlist getMegaPlaylist(AudioBoxClient audioBoxClient)
                                throws java.io.IOException

Gets the mega playlist

. NOTE: this method will always make a request against AudioBox, use carefully. If you want to avoid this behavior consider storing the playlist collection within your application and use ModelUtil.findPlaylistByType(java.util.List, String) in combination with the Playlists#PLAYLIST_* constants to get the right playlist from the memory.

Parameters:

audioBoxClient - the AudioBoxClient to use to make the request

Returns:

the mega playlist

Throws:

AudioBoxException - if any of the remote error exception is detected.

java.io.IOException - if any connection problem occurs.

See Also:

AudioBoxException

getOfflinePlaylist

public static Playlist getOfflinePlaylist(AudioBoxClient audioBoxClient)
                                   throws java.io.IOException

Gets the offline playlist.

NOTE: this method will always make a request against AudioBox, use carefully. If you want to avoid this behavior consider storing the playlist collection within your application and use ModelUtil.findPlaylistByType(java.util.List, String) in combination with the Playlists#PLAYLIST_* constants to get the right playlist from the memory.

Parameters:

audioBoxClient - the AudioBoxClient to use to make the request

Returns:

the offline playlist

Throws:

AudioBoxException - if any of the remote error exception is detected.

java.io.IOException - if any connection problem occurs.

See Also:

AudioBoxException