christophedelory.playlist.m3u
Class M3U

java.lang.Object
  christophedelory.playlist.m3u.M3U

All Implemented Interfaces:

SpecificPlaylist

public class M3U
extends Object
implements SpecificPlaylist

A M3U, M4U, or Real Audio Metadata playlist.

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

M3U()

Method Summary

SpecificPlaylistProvider	getProvider() Returns the provider of this specific playlist.
List<Resource>	getResources() Returns the list of playlist resources.
boolean	isExtensionM3U() Specifies if the marshalled playlist must have the Extension M3U format or not.
void	setExtensionM3U(boolean extensionM3U) Specifies if the marshalled playlist must have the Extension M3U format or not.
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

M3U

public M3U()

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)

setExtensionM3U

public void setExtensionM3U(boolean extensionM3U)

Specifies if the marshalled playlist must have the Extension M3U format or not.

Parameters:

extensionM3U - true if the marshalled playlist must be an Extension M3U, false otherwise.

See Also:

isExtensionM3U()

isExtensionM3U

public boolean isExtensionM3U()

Specifies if the marshalled playlist must have the Extension M3U format or not. Defaults to false.

Returns:

true if the marshalled playlist must be an Extension M3U, false otherwise.

See Also:

setExtensionM3U(boolean)

getResources

public List<Resource> getResources()

Returns the list of playlist resources.

Returns:

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