org.farng.mp3.lyrics3
Class AbstractLyrics3

java.lang.Object
  org.farng.mp3.AbstractMP3FileItem
      org.farng.mp3.AbstractMP3Tag
          org.farng.mp3.lyrics3.AbstractLyrics3

All Implemented Interfaces:

MP3Tag

Direct Known Subclasses:

Lyrics3v1, Lyrics3v2

public abstract class AbstractLyrics3
extends AbstractMP3Tag

Super class for both Lyrics3v2 and Lyrics3v2 tags

Version:

$Revision: 3 $

Author:

Eric Farng

Constructor Summary

AbstractLyrics3()
Creates a new AbstractLyrics3 object.

AbstractLyrics3(AbstractLyrics3 copyObject)
Creates a new AbstractLyrics3 object.

Method Summary

void	append(java.io.RandomAccessFile file) Appends this tag to the given file.
void	delete(java.io.RandomAccessFile file) removes the specific tag the easiest way.
void	overwrite(java.io.RandomAccessFile file) Overwrites this tag to the given file.

Methods inherited from class org.farng.mp3.AbstractMP3Tag

append, equals, isSubsetOf, overwrite, seek, setAlbumTitle, setAuthorComposer, setLeadArtist, setSongComment, setSongGenre, setSongLyric, setSongTitle, setTrackNumberOnAlbum, setYearReleased, write

Methods inherited from class org.farng.mp3.AbstractMP3FileItem

getIdentifier, getSize, isSubsetOf, read, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.farng.mp3.MP3Tag

getAlbumTitle, getAuthorComposer, getLeadArtist, getSongComment, getSongGenre, getSongLyric, getSongTitle, getTrackNumberOnAlbum, getYearReleased, iterator

Constructor Detail

AbstractLyrics3

public AbstractLyrics3()

Creates a new AbstractLyrics3 object.

AbstractLyrics3

public AbstractLyrics3(AbstractLyrics3 copyObject)

Creates a new AbstractLyrics3 object.

Method Detail

append

public void append(java.io.RandomAccessFile file)
            throws java.io.IOException,
                   TagException

Description copied from class: AbstractMP3Tag

Appends this tag to the given file. Append means any information this tag contains will be added to the file's corresponding tag, but it will not replace any fields that the file already has. If the file does not have this specific tag, a new one will be created.

Specified by:

append in class AbstractMP3Tag

Parameters:

file - MP3 file to append to.

Throws:

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

TagException - on any exception generated by this library.

delete

public void delete(java.io.RandomAccessFile file)
            throws java.io.IOException

Description copied from class: AbstractMP3Tag

removes the specific tag the easiest way.
ID3v1 - cuts the length of the tag
lyrics3 -cuts the length of the tag, then writes the id3v1 tag if it existed
id3v2 - just overwrites the ID3 tag indicator at the start of the tag

Specified by:

delete in class AbstractMP3Tag

Parameters:

file - MP3 file to append to.

Throws:

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

overwrite

public void overwrite(java.io.RandomAccessFile file)
               throws java.io.IOException,
                      TagException

Description copied from class: AbstractMP3Tag

Overwrites this tag to the given file. Overwrite means any information this tag contains will replace any existing fields in the file's corresponding tag. If the file does not have this specific tag, a new one will be created.

Specified by:

overwrite in class AbstractMP3Tag

Parameters:

file - MP3 file to overwrite

Throws:

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

TagException - on any exception generated by this library.