christophedelory.playlist.smil
Class Param

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

public class Param
extends ParamGroup

The element which allows a general parameter value to be sent to a media object renderer as a name/value pair. This parameter is sent to the renderer at the time that the media object is processed by the scheduler. Any number of param elements may appear (in any order) in the content of a media object element or in a paramGroup element. If a given parameter is defined multiple times, the lexically last version of that parameter value should be used.

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

Param()

Method Summary

String	getName() Returns the name of the run-time parameter, assumed to be known by the inserted object.
String	getType() Returns the content type of the resource designated by the value attribute only in the case where valuetype is set to "ref".
String	getValue() Returns the value of the run-time parameter specified by name.
String	getValueType() Returns the type of the value attribute.
void	setName(String name) Initializes the name of the run-time parameter.
void	setType(String type) Initializes the content type of the resource designated by the value attribute only in the case where valuetype is set to "ref".
void	setValue(String value) Initializes the value of the run-time parameter specified by name.
void	setValueType(String valueType) Initializes the type of the value attribute.

Methods inherited from class christophedelory.playlist.smil.ParamGroup

addParam, getParams, getSkipContent, isSkipContent, setSkipContent

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

Param

public Param()

Method Detail

getName

public String getName()

Returns the name of the run-time parameter, assumed to be known by the inserted object. Whether the property name is case-sensitive depends on the specific object implementation.

Returns:

a name. Shall not be null.

See Also:

setName(java.lang.String)

setName

public void setName(String name)

Initializes the name of the run-time parameter.

Parameters:

name - a name. Shall not be null.

Throws:

NullPointerException - if name is null.

See Also:

getName()

getType

public String getType()

Returns the content type of the resource designated by the value attribute only in the case where valuetype is set to "ref". This attribute thus specifies for the user agent, the type of values that will be found at the URI designated by value.

Returns:

a content type. May be null.

See Also:

setType(java.lang.String)

setType

public void setType(String type)

Initializes the content type of the resource designated by the value attribute only in the case where valuetype is set to "ref".

Parameters:

type - a content type. May be null.

See Also:

getType()

getValue

public String getValue()

Returns the value of the run-time parameter specified by name. Property values have no meaning to SMIL; their meaning is determined by the object in question.

Returns:

a value as a string. May be null.

See Also:

setValue(java.lang.String)

setValue

public void setValue(String value)

Initializes the value of the run-time parameter specified by name.

Parameters:

value - a value. May be null.

See Also:

getValue()

getValueType

public String getValueType()

Returns the type of the value attribute. Could be "data", "ref", or "object".

Returns:

the type of the value. May be null.

See Also:

setValueType(java.lang.String)

setValueType

public void setValueType(String valueType)

Initializes the type of the value attribute.

Parameters:

valueType - the type of the value. May be null.

See Also:

getValueType()