christophedelory.playlist.smil
Class Head

java.lang.Object
  christophedelory.playlist.smil.Core
      christophedelory.playlist.smil.Head

public class Head
extends Core

Represents the element which contains information that is not related to the temporal behavior of the presentation. Three types of information may be contained by head. These are meta information, layout information, and author-defined content control.

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

Head()

Method Summary

void	acceptDown(SmilVisitor visitor) Accepts the specified SMIL playlist visitor.
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.
Layout	getLayout() Returns the layout associated to this SMIL header.
List<Meta>	getMetas() Returns the list of metadata defined in this SMIL header.
boolean	removeMetaByName(String name) Removes all metadata found with the specified property name from the underlying list of metadata.
void	setLayout(Layout layout) Initializes the layout associated to this SMIL header.

Methods inherited from class christophedelory.playlist.smil.Core

getClassName, getId, getLang, getTitle, setClassName, setId, setLang, setTitle

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

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.smil.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)

getLayout

public Layout getLayout()

Returns the layout associated to this SMIL header.

Returns:

a layout. May be null.

See Also:

setLayout(christophedelory.playlist.smil.Layout)

setLayout

public void setLayout(Layout layout)

Initializes the layout associated to this SMIL header.

Parameters:

layout - a layout. May be null.

See Also:

getLayout()

acceptDown

public void acceptDown(SmilVisitor visitor)

Accepts the specified SMIL playlist visitor.

Parameters:

visitor - a SMIL playlist visitor. Shall not be null.

Throws:

NullPointerException - if visitor is null.