org.intellimate.izou.sdk.frameworks.music.player

Class Playlist

java.lang.Object

org.intellimate.izou.sdk.frameworks.music.player.Playlist

public class Playlist
extends Object

a playlist is a list of TrackInfo-objects, it is immutable!

Version:

1.0

Author:

LeanderK

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATA_DESCRIPTOR
static String	NAME_DESCRIPTOR
static String	PLAYBACK_MODE_DESCRIPTOR
static String	POSITION_DESCRIPTOR
static String	QUEUE_DESCRIPTOR

Constructor Summary

Constructors

Constructor and Description
Playlist(List<TrackInfo> queue)
Playlist(List<TrackInfo> queue, String name, List<PlaybackMode> playbackModes, int position)
Playlist(List<TrackInfo> queue, String name, List<PlaybackMode> playbackModes, int position, String data)
Playlist(String name)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
HashMap<String,Object>	export() exports the Playlist to a HashMap
TrackInfo	getCurrent() returns the current played track or null
Optional<String>	getData() returns the associated data (not really specified, specified by implementation)
Optional<String>	getName() gets the name (optional)
List<PlaybackMode>	getPlaybackModes() retruns the active PlaybackModes
int	getPosition() returns the current position
List<TrackInfo>	getQueue() returns the queue
int	hashCode()
static Optional<Playlist>	importResource(ResourceModel resourceModel) constructs (if no errors were found) the Playlist from the Resource
Playlist	nextTrack() creates a new Playlist, with the next Track as head (or an illegal position if it is the last!!)
Playlist	setNewPosition(int position) creates a new Playlist, with the specified position
Playlist	shuffle() Shuffles the playlist and returns the shuffled playlist, so the original stays intact.
Playlist	update(TrackInfo old, TrackInfo newTrackInfo) updates the TrackInfo-Object
boolean	verify(Capabilities capabilities) returns true if all the active playbackModes are supported

Methods inherited from class java.lang.Object

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

Field Detail

QUEUE_DESCRIPTOR

public static final String QUEUE_DESCRIPTOR

See Also:

Constant Field Values

POSITION_DESCRIPTOR

public static final String POSITION_DESCRIPTOR

See Also:

Constant Field Values

NAME_DESCRIPTOR

public static final String NAME_DESCRIPTOR

See Also:

Constant Field Values

PLAYBACK_MODE_DESCRIPTOR

public static final String PLAYBACK_MODE_DESCRIPTOR

See Also:

Constant Field Values

DATA_DESCRIPTOR

public static final String DATA_DESCRIPTOR

See Also:

Constant Field Values

Constructor Detail

Playlist

public Playlist(String name)

Playlist

public Playlist(List<TrackInfo> queue)

Playlist

public Playlist(List<TrackInfo> queue,
                String name,
                List<PlaybackMode> playbackModes,
                int position)

Playlist

public Playlist(List<TrackInfo> queue,
                String name,
                List<PlaybackMode> playbackModes,
                int position,
                String data)

Method Detail

getQueue

public List<TrackInfo> getQueue()

returns the queue

Returns:

the List of TrackInfo-objects

getCurrent

public TrackInfo getCurrent()

returns the current played track or null

Returns:

an instance of TrackInfo

getPosition

public int getPosition()

returns the current position

Returns:

the current position

getName

public Optional<String> getName()

gets the name (optional)

playlist doesn't need to have a name

Returns:

the optional name

getPlaybackModes

public List<PlaybackMode> getPlaybackModes()

retruns the active PlaybackModes

Returns:

the playbackModes

getData

public Optional<String> getData()

returns the associated data (not really specified, specified by implementation)

Returns:

the optional data-element

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

nextTrack

public Playlist nextTrack()

creates a new Playlist, with the next Track as head (or an illegal position if it is the last!!)

Returns:

a new Playlist

setNewPosition

public Playlist setNewPosition(int position)

creates a new Playlist, with the specified position

Parameters:

position - the position to set to

Returns:

a new Playlist

update

public Playlist update(TrackInfo old,
                       TrackInfo newTrackInfo)

updates the TrackInfo-Object

Parameters:

old - the old TrackInfo

newTrackInfo - the new TrackInfo

Returns:

the resulting new Playlist

shuffle

public Playlist shuffle()

Shuffles the playlist and returns the shuffled playlist, so the original stays intact. Only the part of the playlist after the current position is shuffled.

Returns:

a shuffled copy of this playlist

verify

public boolean verify(Capabilities capabilities)

returns true if all the active playbackModes are supported

Parameters:

capabilities - the Capabilities to match against

Returns:

true if the player is capable, false if not

export

public HashMap<String,Object> export()

exports the Playlist to a HashMap

Returns:

a HashMap

importResource

public static Optional<Playlist> importResource(ResourceModel resourceModel)

constructs (if no errors were found) the Playlist from the Resource

Parameters:

resourceModel - the resourceModel to import from

Returns:

the optional Playlist