org.jaudiotagger.tag.lyrics3
Class FieldFrameBodyLYR

java.lang.Object
  org.jaudiotagger.tag.id3.AbstractTagItem
      org.jaudiotagger.tag.id3.AbstractTagFrameBody
          org.jaudiotagger.tag.lyrics3.AbstractLyrics3v2FieldFrameBody
              org.jaudiotagger.tag.lyrics3.FieldFrameBodyLYR

public class FieldFrameBodyLYR
extends AbstractLyrics3v2FieldFrameBody

Field Summary

private java.util.ArrayList<Lyrics3Line>

lines

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

objectList

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

logger

Constructor Summary

FieldFrameBodyLYR()
Creates a new FieldBodyLYR datatype.

FieldFrameBodyLYR(java.nio.ByteBuffer byteBuffer)
Creates a new FieldBodyLYR datatype.

FieldFrameBodyLYR(FieldFrameBodyLYR copyObject)

FieldFrameBodyLYR(FrameBodySYLT sync)
Creates a new FieldBodyLYR datatype.

FieldFrameBodyLYR(FrameBodyUSLT unsync)
Creates a new FieldBodyLYR datatype.

FieldFrameBodyLYR(java.lang.String line)
Creates a new FieldBodyLYR datatype.

Method Summary

void	addLyric(FrameBodySYLT sync)
void	addLyric(FrameBodyUSLT unsync)
boolean	equals(java.lang.Object obj) Returns true if this datatype and its entire DataType array list equals the argument.
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() Returns the size in bytes of this fragmentbody
boolean	hasTimeStamp()
boolean	isSubsetOf(java.lang.Object obj) Returns true if this instance and its entire DataType array list is a subset of the argument.
java.util.Iterator<Lyrics3Line>	iterator() Returns an iterator of the DataType list.
void	read(java.nio.ByteBuffer byteBuffer) This reads a frame body from its file into the appropriate FrameBody class Read the data from the given file into this datatype.
private void	readString(java.lang.String lineString)
void	setLyric(java.lang.String str)
protected void	setupObjectList() TODO
java.lang.String	toString() Return brief description of FrameBody
void	write(java.io.RandomAccessFile file) Write the contents of this datatype to the file at the position it is currently at.
private java.lang.String	writeString()

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

readHeader, writeHeader

Methods inherited from class org.jaudiotagger.tag.id3.AbstractTagFrameBody

createStructure, getBriefDescription, getHeader, getLongDescription, getObject, getObjectValue, getTextEncoding, getUserFriendlyValue, setHeader, setObjectValue, setTextEncoding

Methods inherited from class java.lang.Object

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

Field Detail

lines

private java.util.ArrayList<Lyrics3Line> lines

Constructor Detail

FieldFrameBodyLYR

public FieldFrameBodyLYR()

Creates a new FieldBodyLYR datatype.

FieldFrameBodyLYR

public FieldFrameBodyLYR(FieldFrameBodyLYR copyObject)

FieldFrameBodyLYR

public FieldFrameBodyLYR(java.lang.String line)

Creates a new FieldBodyLYR datatype.

Parameters:

line -

FieldFrameBodyLYR

public FieldFrameBodyLYR(FrameBodySYLT sync)

Creates a new FieldBodyLYR datatype.

Parameters:

sync -

FieldFrameBodyLYR

public FieldFrameBodyLYR(FrameBodyUSLT unsync)

Creates a new FieldBodyLYR datatype.

Parameters:

unsync -

FieldFrameBodyLYR

public FieldFrameBodyLYR(java.nio.ByteBuffer byteBuffer)
                  throws InvalidTagException

Creates a new FieldBodyLYR datatype.

Parameters:

byteBuffer -

Throws:

InvalidTagException

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 str)

Parameters:

str -

getLyric

public java.lang.String getLyric()

Returns:

getSize

public int getSize()

Description copied from class: AbstractTagFrameBody

Returns the size in bytes of this fragmentbody

Overrides:

getSize in class AbstractTagFrameBody

Returns:

isSubsetOf

public boolean isSubsetOf(java.lang.Object obj)

Description copied from class: AbstractTagFrameBody

Returns true if this instance and its entire DataType array list is a subset of the argument. This class is a subset if it is the same class as the argument.

Overrides:

isSubsetOf in class AbstractTagFrameBody

Parameters:

obj -

Returns:

addLyric

public void addLyric(FrameBodySYLT sync)

Parameters:

sync -

addLyric

public void addLyric(FrameBodyUSLT unsync)

Parameters:

unsync -

equals

public boolean equals(java.lang.Object obj)

Description copied from class: AbstractTagFrameBody

Returns true if this datatype and its entire DataType array list equals the argument. This datatype is equal to the argument if they are the same class.

Overrides:

equals in class AbstractTagFrameBody

Parameters:

obj -

Returns:

hasTimeStamp

public boolean hasTimeStamp()

Returns:

iterator

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

Description copied from class: AbstractTagFrameBody

Returns an iterator of the DataType list.

Overrides:

iterator in class AbstractTagFrameBody

Returns:

read

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

Description copied from class: AbstractLyrics3v2FieldFrameBody

This reads a frame body from its file into the appropriate FrameBody class Read the data from the given file into this datatype. The file needs to have its file pointer in the correct location. The size as indicated in the header is passed to the frame constructor when reading from file.

Overrides:

read in class AbstractLyrics3v2FieldFrameBody

Parameters:

byteBuffer - file to read

Throws:

InvalidTagException - if there is any error in the data format.

toString

public java.lang.String toString()

Description copied from class: AbstractTagFrameBody

Return brief description of FrameBody

Overrides:

toString in class AbstractTagFrameBody

Returns:

write

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

Description copied from class: AbstractLyrics3v2FieldFrameBody

Write the contents of this datatype to the file at the position it is currently at.

Overrides:

write in class AbstractLyrics3v2FieldFrameBody

Parameters:

file -

Throws:

java.io.IOException

readString

private void readString(java.lang.String lineString)

Parameters:

lineString -

writeString

private java.lang.String writeString()

Returns:

setupObjectList

protected void setupObjectList()

TODO

Specified by:

setupObjectList in class AbstractTagFrameBody