org.jaudiotagger.tag.datatype
Class Lyrics3Image

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

public class Lyrics3Image
extends AbstractDataType

Field Summary

private java.lang.String	description
private java.lang.String	filename
private Lyrics3TimeStamp	time

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

frameBody, identifier, logger, size, TYPE_ELEMENT, value

Constructor Summary

Lyrics3Image(Lyrics3Image copy)

Lyrics3Image(java.lang.String identifier, AbstractTagFrameBody frameBody)
Creates a new ObjectLyrics3Image datatype.

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.String	getDescription()
java.lang.String	getFilename()
int	getSize() This defines the size in bytes of the datatype being held when read/written to file.
Lyrics3TimeStamp	getTimeStamp()
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 imageString, int offset)
void	setDescription(java.lang.String description)
void	setFilename(java.lang.String filename)
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

time

private Lyrics3TimeStamp time

description

private java.lang.String description

filename

private java.lang.String filename

Constructor Detail

Lyrics3Image

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

Creates a new ObjectLyrics3Image datatype.

Parameters:

identifier -

frameBody -

Lyrics3Image

public Lyrics3Image(Lyrics3Image copy)

Method Detail

setDescription

public void setDescription(java.lang.String description)

Parameters:

description -

getDescription

public java.lang.String getDescription()

Returns:

setFilename

public void setFilename(java.lang.String filename)

Parameters:

filename -

getFilename

public java.lang.String getFilename()

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 Lyrics3TimeStamp getTimeStamp()

Returns:

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class AbstractDataType

Parameters:

obj -

Returns:

readString

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

Parameters:

imageString -

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