org.farng.mp3.id3
Class FrameBodyCOMM

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

public class FrameBodyCOMM

extends AbstractID3v2FrameBody

4.10. Comments

This frame is intended for any kind of full text information that
does not fit in any other frame. It consists of a frame header
followed by encoding, language and content descriptors and is ended
with the actual comment as a text string. Newline characters are
allowed in the comment text string. There may be more than one

comment frame in each tag, but only one with the same language and
content descriptor.

<Header for 'Comment', ID: "COMM">
Text encoding $xx

Language $xx xx xx
Short content descrip. <text string according to encoding> $00 (00)
The actual text <full text string according to encoding>

Version:

$Revision: 1.4 $

Author:

Eric Farng

Constructor Summary

FrameBodyCOMM()
Creates a new FrameBodyCOMM object.

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

FrameBodyCOMM(FrameBodyCOMM body)
Creates a new FrameBodyCOMM object.

FrameBodyCOMM(java.io.RandomAccessFile file)
Creates a new FrameBodyCOMM 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	getLanguage()
java.lang.String	getText()
byte	getTextEncoding()
void	setDescription(java.lang.String description)
void	setLanguage(java.lang.String language)
void	setText(java.lang.String text)
void	setTextEncoding(byte textEncoding)
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

FrameBodyCOMM

public FrameBodyCOMM()

Creates a new FrameBodyCOMM object.

FrameBodyCOMM

public FrameBodyCOMM(FrameBodyCOMM body)

Creates a new FrameBodyCOMM object.

FrameBodyCOMM

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

Creates a new FrameBodyCOMM object.

FrameBodyCOMM

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

Creates a new FrameBodyCOMM 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

setLanguage

public void setLanguage(java.lang.String language)

getLanguage

public java.lang.String getLanguage()

setText

public void setText(java.lang.String text)

getText

public java.lang.String getText()

setTextEncoding

public void setTextEncoding(byte textEncoding)

getTextEncoding

public byte getTextEncoding()

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