christophedelory.playlist.wpl
Class Head

java.lang.Object
  christophedelory.playlist.wpl.Head

public class Head
extends Object

Contains metadata that applies to the entire playlist. Typically the head element contains a title element and one or more meta elements that define global characteristics of the playlist.
Windows Media Player 9 Series or later.

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

Head()

Method Summary

void	addMeta(Meta meta) Adds the specified metadata to this SMIL header.
Meta	findMetaByName(String name) Returns the first metadata found with the specified property name.
String	getAuthor() Returns the playlist's author.
List<Meta>	getMetas() Returns the list of metadata defined in this SMIL header.
String	getTitle() Returns the playlist's title.
boolean	removeMetaByName(String name) Removes all metadata found with the specified property name from the underlying list of metadata.
void	setAuthor(String author) Initializes the playlist's author.
void	setTitle(String title) Initializes the playlist's title.

Methods inherited from class java.lang.Object

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

Constructor Detail

Head

public Head()

Method Detail

getTitle

public String getTitle()

Returns the playlist's title. When choosing a title for a Windows Media Playlist (WPL), consider that the content of the playlist can be dynamic. A good approach is to base the title on the logic in the argument elements because this is what defines the content of the playlist. Examples of this are "My Favorite Rock Songs from 1966" or "Dance Songs That I Haven't Played Recently".

Returns:

a title. May be null.

See Also:

setTitle(java.lang.String)

setTitle

public void setTitle(String title)

Initializes the playlist's title.

Parameters:

title - a title. May be null.

See Also:

getTitle()

getAuthor

public String getAuthor()

Returns the playlist's author.

Returns:

an author. May be null.

See Also:

setAuthor(java.lang.String)

setAuthor

public void setAuthor(String author)

Initializes the playlist's author.

Parameters:

author - an author. May be null.

See Also:

getAuthor()

addMeta

public void addMeta(Meta meta)

Adds the specified metadata to this SMIL header.

Parameters:

meta - a metadata. Shall not be null.

Throws:

NullPointerException - if meta is null.

See Also:

getMetas()

getMetas

public List<Meta> getMetas()

Returns the list of metadata defined in this SMIL header.

Returns:

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

See Also:

addMeta(christophedelory.playlist.wpl.Meta)

findMetaByName

public Meta findMetaByName(String name)

Returns the first metadata found with the specified property name.

Parameters:

name - the property name. May be null.

Returns:

a metadata instance, or null if none is found.

See Also:

Meta.getName(), getMetas()

removeMetaByName

public boolean removeMetaByName(String name)

Removes all metadata found with the specified property name from the underlying list of metadata.

Parameters:

name - the property name. May be null.

Returns:

true if at least one metadata has been effectively removed, false otherwise.

See Also:

Meta.getName(), getMetas(), findMetaByName(java.lang.String)