org.jaudiotagger.tag.lyrics3
Class Lyrics3v2

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

public class Lyrics3v2
extends AbstractLyrics3

Field Summary

private java.util.HashMap<java.lang.String,Lyrics3v2Field>

fieldMap

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

TYPE_TAG

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

logger

Constructor Summary

Lyrics3v2()
Creates a new Lyrics3v2 datatype.

Lyrics3v2(AbstractTag mp3tag)
Creates a new Lyrics3v2 datatype.

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

Lyrics3v2(Lyrics3v2 copyObject)

Method Summary

boolean	equals(java.lang.Object obj) Determines whether another datatype is equal to this tag.
Lyrics3v2Field	getField(java.lang.String identifier) Gets the value of the frame identified by identifier
int	getFieldCount()
java.lang.String	getIdentifier() ID string that usually corresponds to the class name, but can be displayed to the user.
int	getSize() Return size of this item
boolean	hasField(java.lang.String identifier)
java.util.Iterator<Lyrics3v2Field>	iterator()
void	read(java.nio.ByteBuffer byteBuffer)
void	removeField(java.lang.String identifier)
boolean	seek(java.nio.ByteBuffer byteBuffer) TODO implement
boolean	seek(java.io.RandomAccessFile file)
private int	seekSize(java.nio.ByteBuffer byteBuffer) TODO
void	setField(Lyrics3v2Field field)
java.lang.String	toString()
void	updateField(java.lang.String identifier)
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 org.jaudiotagger.tag.id3.AbstractTagItem

isSubsetOf

Methods inherited from class java.lang.Object

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

Field Detail

fieldMap

private java.util.HashMap<java.lang.String,Lyrics3v2Field> fieldMap

Constructor Detail

Lyrics3v2

public Lyrics3v2()

Creates a new Lyrics3v2 datatype.

Lyrics3v2

public Lyrics3v2(Lyrics3v2 copyObject)

Lyrics3v2

public Lyrics3v2(AbstractTag mp3tag)

Creates a new Lyrics3v2 datatype.

Parameters:

mp3tag -

Throws:

java.lang.UnsupportedOperationException

Lyrics3v2

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

Creates a new Lyrics3v2 datatype.

Parameters:

file -

byteBuffer -

Throws:

TagNotFoundException

java.io.IOException

Method Detail

setField

public void setField(Lyrics3v2Field field)

Parameters:

field -

getField

public Lyrics3v2Field getField(java.lang.String identifier)

Gets the value of the frame identified by identifier

Parameters:

identifier - The three letter code

Returns:

The value associated with the identifier

getFieldCount

public int getFieldCount()

Returns:

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:

getSize

public int getSize()

Description copied from class: AbstractTagItem

Return size of this item

Specified by:

getSize in class AbstractTagItem

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:

hasField

public boolean hasField(java.lang.String identifier)

Parameters:

identifier -

Returns:

iterator

public java.util.Iterator<Lyrics3v2Field> iterator()

Specified by:

iterator in class AbstractTag

Returns:

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 - file to read from

Throws:

TagException - on any exception generated by this library.

removeField

public void removeField(java.lang.String identifier)

Parameters:

identifier -

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:

updateField

public void updateField(java.lang.String identifier)

Parameters:

identifier -

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

seekSize

private int seekSize(java.nio.ByteBuffer byteBuffer)

TODO

Parameters:

byteBuffer -

Returns: