christophedelory.playlist.pls
Class PLS

java.lang.Object
  christophedelory.playlist.pls.PLS

All Implemented Interfaces:

SpecificPlaylist

public class PLS
extends Object
implements SpecificPlaylist

PLS playlist format. The format is essentially that of an INI file structured as follows:

• Header
• "[playlist]": this tag indicates that it is a playlist file.
• "NumberOfEntries": this variable indicates the number of tracks.
• Track entry (assuming track entry #X)
• "FileX": variable defining location of stream.
• "TitleX": defines track title.
• "LengthX": length in seconds of track. Value of -1 indicates indefinite.
• Footer
• "Version": playlist version. Currently only a value of 2 is valid.

Version:

$Revision: 91 $

Author:

Christophe Delory

Constructor Summary

PLS()

Method Summary

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

PLS

public PLS()

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)

getResources

public List<Resource> getResources()

Returns the list of playlist resources.

Returns:

a list of child resources. May be empty but not null.