org.farng.mp3.lyrics3
Class AbstractLyrics3v2FieldBody

java.lang.Object
  org.farng.mp3.AbstractMP3FileItem
      org.farng.mp3.AbstractMP3FragmentBody
          org.farng.mp3.lyrics3.AbstractLyrics3v2FieldBody

All Implemented Interfaces:

MP3MetadataContainer

Direct Known Subclasses:

FieldBodyAUT, FieldBodyEAL, FieldBodyEAR, FieldBodyETT, FieldBodyIMG, FieldBodyIND, FieldBodyINF, FieldBodyLYR, FieldBodyUnsupported

public abstract class AbstractLyrics3v2FieldBody
extends AbstractMP3FragmentBody

Contains the actual text strings for a Lyrics3v2 field.

Version:

$Revision: 3 $

Author:

Eric Farng

Constructor Summary

AbstractLyrics3v2FieldBody()
Creates a new AbstractLyrics3v2FieldBody object.

AbstractLyrics3v2FieldBody(AbstractLyrics3v2FieldBody copyObject)
Creates a new AbstractLyrics3v2FieldBody object.

Method Summary

protected int	readHeader(java.io.RandomAccessFile file) Reads the header for the fragment body.
protected void	writeHeader(java.io.RandomAccessFile file, int size) Write the body header to the file at the current file position.

Methods inherited from class org.farng.mp3.AbstractMP3FragmentBody

appendToObjectList, equals, getBriefDescription, getDescription, getObject, getObjectListIterator, getSize, has6ByteHeader, isSubsetOf, iterator, read, setObject, setupObjectList, toString, write

Methods inherited from class org.farng.mp3.AbstractMP3FileItem

getIdentifier

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractLyrics3v2FieldBody

public AbstractLyrics3v2FieldBody()

Creates a new AbstractLyrics3v2FieldBody object.

AbstractLyrics3v2FieldBody

public AbstractLyrics3v2FieldBody(AbstractLyrics3v2FieldBody copyObject)

Creates a new AbstractLyrics3v2FieldBody object.

Method Detail

readHeader

protected int readHeader(java.io.RandomAccessFile file)
                  throws InvalidTagException,
                         java.io.IOException

Description copied from class: AbstractMP3FragmentBody

Reads the header for the fragment body. The header contains things such as the length.

Specified by:

readHeader in class AbstractMP3FragmentBody

Parameters:

file - file to read the header from.

Returns:

size of body in bytes as stated in the header.

Throws:

InvalidTagException - if there is any error in the data format.

java.io.IOException - on any I/O error

writeHeader

protected void writeHeader(java.io.RandomAccessFile file,
                           int size)
                    throws java.io.IOException

Description copied from class: AbstractMP3FragmentBody

Write the body header to the file at the current file position.

Specified by:

writeHeader in class AbstractMP3FragmentBody

Parameters:

file - file to write to

size - number of bytes the body contains.

Throws:

java.io.IOException - on any I/O error