org.farng.mp3.id3
Class FrameBodyTXXX

java.lang.Object
  org.farng.mp3.AbstractMP3FileItem
      org.farng.mp3.AbstractMP3FragmentBody
          org.farng.mp3.id3.AbstractID3v2FrameBody
              org.farng.mp3.id3.FrameBodyTXXX

public class FrameBodyTXXX

extends AbstractID3v2FrameBody

This frame is intended for one-string text information concerning the
audio file in a similar way to the other "T"-frames. The frame body
consists of a description of the string, represented as a terminated
string, followed by the actual string. There may be more than one

"TXXX" frame in each tag, but only one with the same description.

<Header for 'User defined text information frame', ID: "TXXX">
Text encoding $xx

Description <text string according to encoding> $00 (00)
Value <text string according to encoding>

Version:

$Revision: 1.4 $

Author:

Eric Farng

Constructor Summary

FrameBodyTXXX()
Creates a new FrameBodyTXXX object.

FrameBodyTXXX(byte textEncoding, java.lang.String description, java.lang.String text)
Creates a new FrameBodyTXXX object.

FrameBodyTXXX(FrameBodyTXXX body)
Creates a new FrameBodyTXXX object.

FrameBodyTXXX(java.io.RandomAccessFile file)
Creates a new FrameBodyTXXX object.

Method Summary

java.lang.String	getBriefDescription() This method calls toString for all it's objects and appends them without any newline characters.
java.lang.String	getDescription() This method calls toString for all it's objects and appends them.
java.lang.String	getIdentifier() ID string that usually corresponds to the class name, but can be displayed to the user.
java.lang.String	getText()
void	setDescription(java.lang.String description)
void	setText(java.lang.String text)
protected void	setupObjectList() Create the order of MP3Object objects that this body expects.

Methods inherited from class org.farng.mp3.id3.AbstractID3v2FrameBody

equals, readHeader, writeHeader

Methods inherited from class org.farng.mp3.AbstractMP3FragmentBody

appendToObjectList, getObject, getObjectListIterator, getSize, has6ByteHeader, isSubsetOf, iterator, read, setObject, toString, write

Methods inherited from class java.lang.Object

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

Constructor Detail

FrameBodyTXXX

public FrameBodyTXXX()

Creates a new FrameBodyTXXX object.

FrameBodyTXXX

public FrameBodyTXXX(FrameBodyTXXX body)

Creates a new FrameBodyTXXX object.

FrameBodyTXXX

public FrameBodyTXXX(byte textEncoding,
                     java.lang.String description,
                     java.lang.String text)

Creates a new FrameBodyTXXX object.

FrameBodyTXXX

public FrameBodyTXXX(java.io.RandomAccessFile file)
              throws java.io.IOException,
                     InvalidTagException

Creates a new FrameBodyTXXX object.

Method Detail

getBriefDescription

public java.lang.String getBriefDescription()

Description copied from class: AbstractMP3FragmentBody

This method calls toString for all it's objects and appends them without any newline characters.

Overrides:

getBriefDescription in class AbstractMP3FragmentBody

Returns:

brief description string

setDescription

public void setDescription(java.lang.String description)

getDescription

public java.lang.String getDescription()

Description copied from class: AbstractMP3FragmentBody

This method calls toString for all it's objects and appends them. It contains new line characters and is more suited for display purposes

Overrides:

getDescription in class AbstractMP3FragmentBody

Returns:

formatted description string

getIdentifier

public java.lang.String getIdentifier()

Description copied from class: AbstractMP3FileItem

ID string that usually corresponds to the class name, but can be displayed to the user. It is not indended to identify each individual instance.

Specified by:

getIdentifier in class AbstractMP3FileItem

Returns:

ID string

setText

public void setText(java.lang.String text)

getText

public java.lang.String getText()

setupObjectList

protected void setupObjectList()

Description copied from class: AbstractMP3FragmentBody

Create the order of MP3Object objects that this body expects. This method needs to be overwritten.

Specified by:

setupObjectList in class AbstractMP3FragmentBody