org.jaudiotagger.tag.datatype
Class Lyrics3Line

java.lang.Object
  org.jaudiotagger.tag.datatype.AbstractDataType
      org.jaudiotagger.tag.datatype.Lyrics3Line

public class Lyrics3Line
extends AbstractDataType

Field Summary

private java.lang.String	lyric
private java.util.LinkedList<Lyrics3TimeStamp>	timeStamp

Fields inherited from class org.jaudiotagger.tag.datatype.AbstractDataType

frameBody, identifier, logger, size, TYPE_ELEMENT, value

Constructor Summary

Lyrics3Line(Lyrics3Line copy)

Lyrics3Line(java.lang.String identifier, AbstractTagFrameBody frameBody)
Creates a new ObjectLyrics3Line datatype.

Method Summary

void	addLyric(ID3v2LyricLine line)
void	addLyric(java.lang.String newLyric)
void	addTimeStamp(Lyrics3TimeStamp time)
boolean	equals(java.lang.Object obj)
java.lang.String	getLyric()
int	getSize() This defines the size in bytes of the datatype being held when read/written to file.
java.util.Iterator<Lyrics3TimeStamp>	getTimeStamp()
boolean	hasTimeStamp()
void	readByteArray(byte[] arr, int offset) This is the starting point for reading bytes from the file into the ID3 datatype starting at offset.
void	readString(java.lang.String lineString, int offset)
void	setLyric(ID3v2LyricLine line)
void	setLyric(java.lang.String lyric)
void	setTimeStamp(Lyrics3TimeStamp time)
java.lang.String	toString()
byte[]	writeByteArray() Starting point write ID3 Datatype back to array of bytes.
java.lang.String	writeString()

Methods inherited from class org.jaudiotagger.tag.datatype.AbstractDataType

createStructure, getBody, getIdentifier, getValue, readByteArray, setBody, setValue

Methods inherited from class java.lang.Object

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

Field Detail

timeStamp

private java.util.LinkedList<Lyrics3TimeStamp> timeStamp

lyric

private java.lang.String lyric

Constructor Detail

Lyrics3Line

public Lyrics3Line(java.lang.String identifier,
                   AbstractTagFrameBody frameBody)

Creates a new ObjectLyrics3Line datatype.

Parameters:

identifier -

frameBody -

Lyrics3Line

public Lyrics3Line(Lyrics3Line copy)

Method Detail

setLyric

public void setLyric(java.lang.String lyric)

setLyric

public void setLyric(ID3v2LyricLine line)

getLyric

public java.lang.String getLyric()

Returns:

getSize

public int getSize()

Description copied from class: AbstractDataType

This defines the size in bytes of the datatype being held when read/written to file.

Specified by:

getSize in class AbstractDataType

Returns:

setTimeStamp

public void setTimeStamp(Lyrics3TimeStamp time)

Parameters:

time -

getTimeStamp

public java.util.Iterator<Lyrics3TimeStamp> getTimeStamp()

Returns:

addLyric

public void addLyric(java.lang.String newLyric)

addLyric

public void addLyric(ID3v2LyricLine line)

addTimeStamp

public void addTimeStamp(Lyrics3TimeStamp time)

Parameters:

time -

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class AbstractDataType

Parameters:

obj -

Returns:

hasTimeStamp

public boolean hasTimeStamp()

Returns:

readString

public void readString(java.lang.String lineString,
                       int offset)

Parameters:

lineString -

offset -

Throws:

java.lang.NullPointerException

java.lang.IndexOutOfBoundsException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

writeString

public java.lang.String writeString()

Returns:

readByteArray

public void readByteArray(byte[] arr,
                          int offset)
                   throws InvalidDataTypeException

Description copied from class: AbstractDataType

This is the starting point for reading bytes from the file into the ID3 datatype starting at offset. This class must be overridden

Specified by:

readByteArray in class AbstractDataType

Throws:

InvalidDataTypeException

writeByteArray

public byte[] writeByteArray()

Description copied from class: AbstractDataType

Starting point write ID3 Datatype back to array of bytes. This class must be overridden.

Specified by:

writeByteArray in class AbstractDataType

Returns:

the array of bytes representing this datatype that should be written to file