christophedelory.playlist.kpl
Class Xml

java.lang.Object
  christophedelory.playlist.kpl.Xml

All Implemented Interfaces:

SpecificPlaylist

public class Xml
extends Object
implements SpecificPlaylist

The definition of a Kalliope playlist (KPL). According to the Kalliope Playlist 1.0 specification, the .KPL file is divided into two logical parts: a playlist section and an information section. The most important part of the file is the information section; see Info. The second part of the file is the playlist section; see Entry.

Since:

0.3.0

Version:

$Revision: 91 $

Author:

Christophe Delory

Constructor Summary

Xml()

Method Summary

List<Entry>	getEntries() Returns the list of entries in this playlist.
Info	getInfo() Returns the information section of this playlist.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

Xml

public Xml()

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)

getEntries

public List<Entry> getEntries()

Returns the list of entries in this playlist.

Returns:

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

getInfo

public Info getInfo()

Returns the information section of this playlist.

Returns:

an information section. Shall not be null.