org.blinkenlights.jid3.v2
Class USLTID3V2Frame

java.lang.Object
  org.blinkenlights.jid3.v2.ID3V2Frame
      org.blinkenlights.jid3.v2.USLTID3V2Frame

All Implemented Interfaces:

ID3Subject, ID3Visitable

public class USLTID3V2Frame

extends ID3V2Frame

Frame containing unsynchronized lyrics/text transcription.

Constructor Summary

USLTID3V2Frame(java.io.InputStream oIS)

USLTID3V2Frame(java.lang.String sLanguage, java.lang.String sContentDescriptor, java.lang.String sLyrics)

Method Summary

void	accept(ID3Visitor oID3Visitor) Accept a visitor.
boolean	equals(java.lang.Object oOther)
java.lang.String	getContentDescriptor() Get the content descriptor for this frame.
protected byte[]	getFrameId() Get the four bytes which uniquely specify of which type this frame is.
java.lang.String	getLanguage() Get the language used in this frame.
java.lang.String	getLyrics() Get the lyrics for this frame.
TextEncoding	getTextEncoding() Get the text encoding used for the content descriptor and lyrics in this frame.
void	setContentDescriptor(java.lang.String sContentDescriptor) Set the content descriptor for this frame.
void	setLanguage(java.lang.String sLanguage) Set the language used in this frame.
void	setLyrics(java.lang.String sLyrics) Set the lyrics for this frame.
void	setTextEncoding(TextEncoding oTextEncoding) Set the text encoding to be used for the content descriptor and lyrics in this frame.
java.lang.String	toString() Represent the contents of this frame as a string.
protected void	writeBody(ID3DataOutputStream oIDOS) Write the body of the frame to an ID3 data output stream.

Methods inherited from class org.blinkenlights.jid3.v2.ID3V2Frame

addID3Observer, getEncryptionMethod, isEncrypted, notifyID3Observers, removeID3Observer, setCompressionFlag, setEncryption, setFileAlterPreservationFlag, setGroupingIdentityFlag, setReadOnlyFlag, setTagAlterPreservationFlag, write, writeHeader

Methods inherited from class java.lang.Object

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

Constructor Detail

USLTID3V2Frame

public USLTID3V2Frame(java.lang.String sLanguage,
                      java.lang.String sContentDescriptor,
                      java.lang.String sLyrics)
               throws ID3Exception

USLTID3V2Frame

public USLTID3V2Frame(java.io.InputStream oIS)
               throws ID3Exception

Method Detail

accept

public void accept(ID3Visitor oID3Visitor)

Description copied from interface: ID3Visitable

Accept a visitor.

Parameters:

oID3Visitor - a visitor of this object

setTextEncoding

public void setTextEncoding(TextEncoding oTextEncoding)

Set the text encoding to be used for the content descriptor and lyrics in this frame.

Parameters:

oTextEncoding - the text encoding to be used for this frame

getTextEncoding

public TextEncoding getTextEncoding()

Get the text encoding used for the content descriptor and lyrics in this frame.

Returns:

the text encoding to be used for this frame

setLanguage

public void setLanguage(java.lang.String sLanguage)
                 throws ID3Exception

Set the language used in this frame.

Parameters:

sLanguage - a three letter language code

Throws:

ID3Exception - if the language is null or not three characters in length or if this frame is in a tag which contains another USLT frame with the same language and content descriptor

getLanguage

public java.lang.String getLanguage()

Get the language used in this frame.

Returns:

a three letter language code

setContentDescriptor

public void setContentDescriptor(java.lang.String sContentDescriptor)
                          throws ID3Exception

Set the content descriptor for this frame.

Parameters:

sContentDescriptor - the content descriptor for this frame

Throws:

ID3Exception - if the content descriptor is null, or if this frame is in a tag which contains another USLT frame with the same language and content descriptor

getContentDescriptor

public java.lang.String getContentDescriptor()

Get the content descriptor for this frame.

Returns:

the content descriptor

setLyrics

public void setLyrics(java.lang.String sLyrics)

Set the lyrics for this frame.

Parameters:

sLyrics - the lyrics for this frame

getLyrics

public java.lang.String getLyrics()

Get the lyrics for this frame.

Returns:

the lyrics

getFrameId

protected byte[] getFrameId()

Description copied from class: ID3V2Frame

Get the four bytes which uniquely specify of which type this frame is.

Specified by:

getFrameId in class ID3V2Frame

toString

public java.lang.String toString()

Description copied from class: ID3V2Frame

Represent the contents of this frame as a string. For debugging purposes.

Specified by:

toString in class ID3V2Frame

Returns:

a string representing this frame

writeBody

protected void writeBody(ID3DataOutputStream oIDOS)
                  throws java.io.IOException

Description copied from class: ID3V2Frame

Write the body of the frame to an ID3 data output stream.

Specified by:

writeBody in class ID3V2Frame

Parameters:

oIDOS - the output stream to write to

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object oOther)