christophedelory.rss.media
Class Description

java.lang.Object
  christophedelory.rss.media.Description

public class Description
extends Object

A short description describing the media object, typically a sentence in length. Example:

 <media:description type="plain">This was some really bizarre band I listened to as a young lad.</media:description>
 

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

Description()

Method Summary

String	getType() Returns the type of text embedded.
String	getValue() Returns the description itself.
void	setType(String type) Initializes the type of text embedded.
void	setValue(String value) Initializes the description itself.

Methods inherited from class java.lang.Object

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

Constructor Detail

Description

public Description()

Method Detail

setValue

public void setValue(String value)

Initializes the description itself.

Parameters:

value - a description text. Shall not be null.

Throws:

NullPointerException - if value is null.

See Also:

getValue()

getValue

public String getValue()

Returns the description itself. All html must be entity-encoded.

Returns:

a description text. May be null if not yet initialized.

See Also:

setValue(java.lang.String)

setType

public void setType(String type)

Initializes the type of text embedded.

Parameters:

type - a description's type. May be null.

See Also:

getType()

getType

public String getType()

Returns the type of text embedded. Possible values are either 'plain' or 'html'. Default value is 'plain'.

Returns:

a description's type. May be null.

See Also:

setType(java.lang.String)