bbc.rd.tvanytime
Class CaptionLanguage

java.lang.Object
  extended by bbc.rd.tvanytime.CaptionLanguage
All Implemented Interfaces:
java.lang.Cloneable

public class CaptionLanguage
extends java.lang.Object
implements java.lang.Cloneable

CaptionLanguage: Represents a description of a CaptionLanguage.

Version:
1.0
Author:
Tim Sargeant, BBC Research & Development, February 2003

Constructor Summary
CaptionLanguage()
          Create CaptionLanguage object.
 
Method Summary
 java.lang.Object clone()
          Clones itself.
 java.lang.String getLanguage()
          Get language
 boolean isClosed()
          Is this using closed captioning?
 boolean isSupplemental()
          Is this using supplemental captioning?
 void setClosed(boolean closed)
          Set closed captioning flag
 void setLanguage(java.lang.String language)
          Set language
 void setSupplemental(boolean supplemental)
          Set supplemental captioning flag
 java.lang.String toString()
          Returns string representation of the audio attributes.
 java.lang.String toString(int indent)
          Returns string representation of the audio attributes.
 java.lang.String toXML()
          Returns XML representation of the audio attributes.
 java.lang.String toXML(int indent)
          Returns XML representation of the audio attributes.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CaptionLanguage

public CaptionLanguage()
Create CaptionLanguage object.

Method Detail

getLanguage

public java.lang.String getLanguage()
Get language

Returns:
language a string representing the language

isClosed

public boolean isClosed()
Is this using closed captioning?

Returns:
closed captioning in use? (false if unset)

isSupplemental

public boolean isSupplemental()
Is this using supplemental captioning?

Returns:
supplemental captioning in use? (false if unset)

setLanguage

public void setLanguage(java.lang.String language)
Set language

Parameters:
language - a string representing the language

setClosed

public void setClosed(boolean closed)
Set closed captioning flag

Parameters:
closed - captioning value

setSupplemental

public void setSupplemental(boolean supplemental)
Set supplemental captioning flag

Parameters:
supplemental - captioning value

toXML

public java.lang.String toXML()
Returns XML representation of the audio attributes.

Returns:
XML representation of the audio attributes.

toXML

public java.lang.String toXML(int indent)
Returns XML representation of the audio attributes.

Parameters:
indent - Number of tabs with which to indent the string.
Returns:
XML representation of the audio attributes.

toString

public java.lang.String toString()
Returns string representation of the audio attributes.

Overrides:
toString in class java.lang.Object
Returns:
String representation of the audio attributes.

toString

public java.lang.String toString(int indent)
Returns string representation of the audio attributes.

Parameters:
indent - Number of tabs with which to indent the string.
Returns:
string representation of the audio attributes.

clone

public java.lang.Object clone()
Clones itself.

Overrides:
clone in class java.lang.Object
Returns:
A copy of itself.