christophedelory.playlist.smil
Class ParamGroup

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

Direct Known Subclasses:

Param

public class ParamGroup
extends Core

This element provides a convenience mechanism for defining a group of media parameters that may be used with several different media objects. If present, the paramGroup element must appear in the head section of the document. The content of the paramGroup element consists of zero or more param elements. The paramGroup element may not contain nested paramGroup element definitions.

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

ParamGroup()

Method Summary

void	addParam(Param param) Adds a parameter to this group of parameters.
List<Param>	getParams() Returns the list of parameters defined in this group of parameters.
Boolean	getSkipContent() Checks if the content may be skipped or not.
boolean	isSkipContent() Checks if the content may be skipped or not.
void	setSkipContent(Boolean skipContent) Specifies if the content may be skipped or not.

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

ParamGroup

public ParamGroup()

Method Detail

isSkipContent

public boolean isSkipContent()

Checks if the content may be skipped or not.

Returns:

the associated boolean.

See Also:

getSkipContent()

getSkipContent

public Boolean getSkipContent()

Checks if the content may be skipped or not. The skip content controls whether the content of an element is evaluated or should be skipped.

Returns:

the associated boolean. May be null.

See Also:

setSkipContent(java.lang.Boolean), isSkipContent()

setSkipContent

public void setSkipContent(Boolean skipContent)

Specifies if the content may be skipped or not.

Parameters:

skipContent - the associated boolean. May be null.

See Also:

getSkipContent()

getParams

public List<Param> getParams()

Returns the list of parameters defined in this group of parameters.

Returns:

the list of parameters. May be empty but not null.

See Also:

addParam(christophedelory.playlist.smil.Param)

addParam

public void addParam(Param param)

Adds a parameter to this group of parameters.

Parameters:

param - a parameter. Shall not be null.

Throws:

NullPointerException - if param is null.

See Also:

getParams()