christophedelory.playlist.hypetape
Class Playlist

java.lang.Object
  christophedelory.playlist.hypetape.Playlist

All Implemented Interfaces:

SpecificPlaylist

public class Playlist
extends Object
implements SpecificPlaylist

The top-level element.

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

Playlist()

Method Summary

void	addTrack(Track track) Adds a track to this playlist.
SpecificPlaylistProvider	getProvider() Returns the provider of this specific playlist.
List<Track>	getTracks() Returns the list of tracks.
void	setProvider(SpecificPlaylistProvider provider) Initializes the provider of this specific playlist.
Playlist	toPlaylist() Builds a generic representation from this specific playlist.
void	writeTo(OutputStream out, String encoding) Writes this specific playlist to the specified output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

Playlist

public Playlist()

Method Detail

setProvider

public void setProvider(SpecificPlaylistProvider provider)

Description copied from interface: SpecificPlaylist

Initializes the provider of this specific playlist.

Specified by:

setProvider in interface SpecificPlaylist

Parameters:

provider - the provider of this playlist. Shall not be null.

See Also:

SpecificPlaylist.getProvider()

getProvider

public SpecificPlaylistProvider getProvider()

Description copied from interface: SpecificPlaylist

Returns the provider of this specific playlist.

Specified by:

getProvider in interface SpecificPlaylist

Returns:

the provider of this playlist. May be null.

See Also:

SpecificPlaylist.setProvider(christophedelory.playlist.SpecificPlaylistProvider)

writeTo

public void writeTo(OutputStream out,
                    String encoding)
             throws Exception

Description copied from interface: SpecificPlaylist

Writes this specific playlist to the specified output stream. When done, the stream may be flushed, but not closed.

Specified by:

writeTo in interface SpecificPlaylist

Parameters:

out - an output stream. Shall not be null.

encoding - the content encoding of the output resource, or null if not known.

Throws:

NullPointerException - if out is null.

Exception - if any error occurs during the marshalling process.

See Also:

SpecificPlaylistFactory.readFrom(java.net.URL), SpecificPlaylistProvider.readFrom(java.io.InputStream, java.lang.String, org.apache.commons.logging.Log)

toPlaylist

public Playlist toPlaylist()

Description copied from interface: SpecificPlaylist

Builds a generic representation from this specific playlist.

Specified by:

toPlaylist in interface SpecificPlaylist

Returns:

a generic playlist. Shall not be null.

See Also:

SpecificPlaylistProvider.toSpecificPlaylist(christophedelory.playlist.Playlist)

addTrack

public void addTrack(Track track)

Adds a track to this playlist.

Parameters:

track - a track. Shall not be null

Throws:

NullPointerException - if track is null.

See Also:

getTracks()

getTracks

public List<Track> getTracks()

Returns the list of tracks.

Returns:

a list of tracks. May be empty but not null.

See Also:

addTrack(christophedelory.playlist.hypetape.Track)