Package cz.martlin.xspf.playlist.elements

Class XSPFFile

java.lang.Object

cz.martlin.xspf.playlist.base.XSPFNode

cz.martlin.xspf.playlist.elements.XSPFFile

public class XSPFFile
extends XSPFNode

The whole xspf file. Contains XSPFPlaylist instance. Can be created (create()) or loaded (load(File)). Then can be saved (save(File)).

Author:

martin

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	XSPF_STANDART_VERSION	The supported version of the XSPF file standart.

Fields inherited from class cz.martlin.xspf.playlist.base.XSPFNode

UTIL

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	XSPFFile(Document document)	Creates instance.

Method Summary

Modifier and Type	Method	Description
static XSPFFile	create()	Creates empty xspf file.
boolean	equals(Object obj)
Document	getDocument()	Returns the playlist XML document.
Node	getNode()
XSPFPlaylist	getPlaylist()	Returns the (copy of) the playlist.
int	hashCode()
static XSPFFile	load(File file)	Loads the XSPF playlist from the given file.
XSPFAttribution	newAttribution()	Creates new attribution.
XSPFExtensions	newExtensions()	Creates new collection of extensions.
XSPFLinks	newLinks()	Creates new collection of links.
XSPFMetas	newMetas()	Creates new collection of metas.
XSPFPlaylist	newPlaylist()	Creates new playlist.
XSPFTracks	newTracks()	Creates new collection of tracks.
XSPFPlaylist	playlist()	Return the (view of) the playlist.
void	save(File file)	Saves this xspf file to the given file.
void	setPlaylist(XSPFPlaylist playlist)	Sets the (copy of) the playlist.
String	toString()

Methods inherited from class cz.martlin.xspf.playlist.base.XSPFNode

createOne, getAll, getOne, one, setAll, setOne

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

XSPF_STANDART_VERSION

protected static final String XSPF_STANDART_VERSION

The supported version of the XSPF file standart.

See Also:

Constant Field Values

Constructor Detail

XSPFFile

protected XSPFFile(Document document)

Creates instance. To create brand new playlist, use create().

Parameters:

document - the XSPF file XML document.

Method Detail

getDocument

public Document getDocument()

Returns the playlist XML document.

Returns:

getNode

public Node getNode()

Specified by:

getNode in class XSPFNode

getPlaylist

public XSPFPlaylist getPlaylist()
                         throws XSPFException

Returns the (copy of) the playlist.

Returns:

Throws:

XSPFException

playlist

public XSPFPlaylist playlist()
                      throws XSPFException

Return the (view of) the playlist.

Returns:

Throws:

XSPFException

setPlaylist

public void setPlaylist(XSPFPlaylist playlist)
                 throws XSPFException

Sets the (copy of) the playlist.

Parameters:

playlist -

Throws:

XSPFException

newMetas

public XSPFMetas newMetas()
                   throws XSPFException

Creates new collection of metas.

Returns:

Throws:

XSPFException

newLinks

public XSPFLinks newLinks()
                   throws XSPFException

Creates new collection of links.

Returns:

Throws:

XSPFException

newExtensions

public XSPFExtensions newExtensions()
                             throws XSPFException

Creates new collection of extensions.

Returns:

Throws:

XSPFException

newTracks

public XSPFTracks newTracks()
                     throws XSPFException

Creates new collection of tracks.

Returns:

Throws:

XSPFException

newPlaylist

public XSPFPlaylist newPlaylist()
                         throws XSPFException

Creates new playlist.

Returns:

Throws:

XSPFException

newAttribution

public XSPFAttribution newAttribution()
                               throws XSPFException

Creates new attribution.

Returns:

Throws:

XSPFException

load

public static XSPFFile load(File file)
                     throws XSPFException

Loads the XSPF playlist from the given file.

Parameters:

file -

Returns:

Throws:

XSPFException

create

public static XSPFFile create()
                       throws XSPFException

Creates empty xspf file.

Returns:

Throws:

XSPFException

save

public void save(File file)
          throws XSPFException

Saves this xspf file to the given file.

Parameters:

file -

Throws:

XSPFException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object