org.jaudiotagger.tag.lyrics3
Class Lyrics3v1

java.lang.Object
  org.jaudiotagger.tag.id3.AbstractTagItem
      org.jaudiotagger.tag.id3.AbstractTag
          org.jaudiotagger.tag.lyrics3.AbstractLyrics3
              org.jaudiotagger.tag.lyrics3.Lyrics3v1

public class Lyrics3v1
extends AbstractLyrics3

Field Summary

private java.lang.String

lyric

Fields inherited from class org.jaudiotagger.tag.id3.AbstractTag

TYPE_TAG

Fields inherited from class org.jaudiotagger.tag.id3.AbstractTagItem

logger

Constructor Summary

Lyrics3v1()
Creates a new Lyrics3v1 datatype.

Lyrics3v1(AbstractTag mp3Tag)

Lyrics3v1(java.nio.ByteBuffer byteBuffer)
Creates a new Lyrics3v1 datatype.

Lyrics3v1(Lyrics3v1 copyObject)

Method Summary

boolean	equals(java.lang.Object obj) Determines whether another datatype is equal to this tag.
java.lang.String	getIdentifier() ID string that usually corresponds to the class name, but can be displayed to the user.
java.lang.String	getLyric()
int	getSize() Return size of this item
boolean	isSubsetOf(java.lang.Object obj) Returns true if this datatype is a subset of the argument.
java.util.Iterator	iterator()
void	read(java.nio.ByteBuffer byteBuffer)
boolean	seek(java.nio.ByteBuffer byteBuffer) TODO implement
boolean	seek(java.io.RandomAccessFile file)
void	setLyric(java.lang.String lyric)
java.lang.String	toString()
void	write(java.io.RandomAccessFile file) Writes the tag to the file

Methods inherited from class org.jaudiotagger.tag.lyrics3.AbstractLyrics3

delete

Methods inherited from class java.lang.Object

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

Field Detail

lyric

private java.lang.String lyric

Constructor Detail

Lyrics3v1

public Lyrics3v1()

Creates a new Lyrics3v1 datatype.

Lyrics3v1

public Lyrics3v1(Lyrics3v1 copyObject)

Lyrics3v1

public Lyrics3v1(AbstractTag mp3Tag)

Lyrics3v1

public Lyrics3v1(java.nio.ByteBuffer byteBuffer)
          throws TagNotFoundException,
                 java.io.IOException

Creates a new Lyrics3v1 datatype.

Parameters:

file -

byteBuffer -

Throws:

TagNotFoundException

java.io.IOException

Method Detail

getIdentifier

public java.lang.String getIdentifier()

Description copied from class: AbstractTagItem

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 AbstractTagItem

Returns:

setLyric

public void setLyric(java.lang.String lyric)

Parameters:

lyric -

getLyric

public java.lang.String getLyric()

Returns:

getSize

public int getSize()

Description copied from class: AbstractTagItem

Return size of this item

Specified by:

getSize in class AbstractTagItem

Returns:

isSubsetOf

public boolean isSubsetOf(java.lang.Object obj)

Description copied from class: AbstractTagItem

Returns true if this datatype is a subset of the argument. This instance is a subset if it is the same class as the argument.

Overrides:

isSubsetOf in class AbstractTagItem

Parameters:

obj -

Returns:

equals

public boolean equals(java.lang.Object obj)

Description copied from class: AbstractTag

Determines whether another datatype is equal to this tag. It just compares if they are the same class, then calls super.equals(obj).

Overrides:

equals in class AbstractTag

Parameters:

obj -

Returns:

iterator

public java.util.Iterator iterator()

Specified by:

iterator in class AbstractTag

Returns:

Throws:

java.lang.UnsupportedOperationException

seek

public boolean seek(java.nio.ByteBuffer byteBuffer)

TODO implement

Specified by:

seek in class AbstractTag

Parameters:

byteBuffer -

Returns:

Throws:

java.io.IOException

read

public void read(java.nio.ByteBuffer byteBuffer)
          throws TagException

Specified by:

read in class AbstractTagItem

Parameters:

byteBuffer -

Throws:

TagNotFoundException

java.io.IOException

TagException - on any exception generated by this library.

seek

public boolean seek(java.io.RandomAccessFile file)
             throws java.io.IOException

Parameters:

file -

Returns:

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

write

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

Description copied from class: AbstractTag

Writes the tag to the file

Specified by:

write in class AbstractTag

Parameters:

file -

Throws:

java.io.IOException