Class Song

java.lang.Object

de.pottgames.tuningfork.jukebox.song.Song

public class Song
extends Object

An immutable data class containing a SongSource and a SongSettings object meant to be added to a PlayList that can be played via JukeBox.

Constructor Summary

Constructors

Constructor	Description
Song(SongSource source)	Creates a new Song with default settings.
Song(SongSource source, SongSettings settings)	Creates a new Song with the given settings.
Song(SongSource source, SongSettings settings, SongMeta metaData)	Creates a new Song with the given settings and meta-data.

Method Summary

Modifier and Type	Method	Description
SongMeta	getMeta()	Returns the SongMeta.
SongSettings	getSettings()	Returns the SongSettings.
SongSource	getSource()	Returns the SongSource.
String	toString()

Methods inherited from class Object

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

Constructor Details

Song

public Song(SongSource source)

Creates a new Song with default settings. See SongSettings.DEFAULT for details.

Parameters:

source - the song source

Song

public Song(SongSource source,
 SongSettings settings)

Creates a new Song with the given settings.

Parameters:

source - the song source

settings - if null, default settings will be used, see SongSettings.DEFAULT for details

Song

public Song(SongSource source,
 SongSettings settings,
 SongMeta metaData)

Creates a new Song with the given settings and meta-data.

Parameters:

source - the song source

settings - if null, default settings will be used, see SongSettings.DEFAULT for details

metaData - may be null

Method Details

getSource

public SongSource getSource()

Returns the SongSource.

Returns:

the source

getSettings

public SongSettings getSettings()

Returns the SongSettings.

Returns:

the settings

getMeta

public SongMeta getMeta()

Returns the SongMeta.

Returns:

the meta data

toString

public String toString()

Overrides:

toString in class Object