christophedelory.playlist
Interface SpecificPlaylist

All Known Implementing Classes:

Asx, AtomPlaylist, M3U, MPCPL, Package, PLA, Playlist, Playlist, PlistPlaylist, PLP, PLS, RSSPlaylist, Smil, Smil, WinampXML, Xml

public interface SpecificPlaylist

The base definition of a specific playlist implementation.

Version:

$Revision: 92 $

Author:

Christophe Delory

Method Summary

SpecificPlaylistProvider	getProvider() Returns the provider of this specific playlist.
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.

Method Detail

setProvider

void setProvider(SpecificPlaylistProvider provider)

Initializes the provider of this specific playlist.

Parameters:

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

Throws:

NullPointerException - if provider is null.

See Also:

getProvider()

getProvider

SpecificPlaylistProvider getProvider()

Returns the provider of this specific playlist.

Returns:

the provider of this playlist. May be null.

See Also:

setProvider(christophedelory.playlist.SpecificPlaylistProvider)

writeTo

void writeTo(OutputStream out,
             String encoding)
             throws Exception

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

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

Playlist toPlaylist()

Builds a generic representation from this specific playlist.

Returns:

a generic playlist. Shall not be null.

See Also:

SpecificPlaylistProvider.toSpecificPlaylist(christophedelory.playlist.Playlist)