org.farng.mp3.lyrics3
Class FieldBodyUnsupported

java.lang.Object
  org.farng.mp3.AbstractMP3FileItem
      org.farng.mp3.AbstractMP3FragmentBody
          org.farng.mp3.lyrics3.AbstractLyrics3v2FieldBody
              org.farng.mp3.lyrics3.FieldBodyUnsupported

public class FieldBodyUnsupported

extends AbstractLyrics3v2FieldBody

This is used if the field identifier is not recognized. the contents of the frame are read as a byte stream and kept so they can be saved when the file is written again

Version:

$Revision: 1.4 $

Author:

Eric Farng

Constructor Summary

FieldBodyUnsupported()
Creates a new FieldBodyUnsupported object.

FieldBodyUnsupported(byte[] value)
Creates a new FieldBodyUnsupported object.

FieldBodyUnsupported(FieldBodyUnsupported copyObject)
Creates a new FieldBodyUnsupported object.

FieldBodyUnsupported(java.io.RandomAccessFile file)
Creates a new FieldBodyUnsupported object.

Method Summary

boolean	equals(java.lang.Object obj) Returns true if this object and its entire MP3Object 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.
boolean	isSubsetOf(java.lang.Object object) Returns true if this instance and its entire MP3Object array list is a subset of the argument.
void	read(java.io.RandomAccessFile file) Read the data from the given file into this object.
protected void	setupObjectList() Create the order of MP3Object objects that this body expects.
java.lang.String	toString() Calls toString for all MP3Object objects and creates a string with a new line character.
void	write(java.io.RandomAccessFile file) Write the contents of this object to the file at the position it is currently at.

Methods inherited from class org.farng.mp3.lyrics3.AbstractLyrics3v2FieldBody

readHeader, writeHeader

Methods inherited from class org.farng.mp3.AbstractMP3FragmentBody

appendToObjectList, getBriefDescription, getDescription, getObject, getObjectListIterator, getSize, has6ByteHeader, iterator, setObject

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldBodyUnsupported

public FieldBodyUnsupported()

Creates a new FieldBodyUnsupported object.

FieldBodyUnsupported

public FieldBodyUnsupported(FieldBodyUnsupported copyObject)

Creates a new FieldBodyUnsupported object.

FieldBodyUnsupported

public FieldBodyUnsupported(byte[] value)

Creates a new FieldBodyUnsupported object.

FieldBodyUnsupported

public FieldBodyUnsupported(java.io.RandomAccessFile file)
                     throws java.io.IOException

Creates a new FieldBodyUnsupported object.

Method Detail

getIdentifier

public java.lang.String getIdentifier()

Description copied from class: AbstractMP3FileItem

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 AbstractMP3FileItem

Returns:

ID string

isSubsetOf

public boolean isSubsetOf(java.lang.Object object)

Description copied from class: AbstractMP3FragmentBody

Returns true if this instance and its entire MP3Object 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 AbstractMP3FragmentBody

Parameters:

object - object to determine subset of

Returns:

true if this instance and its entire object array list is a subset of the argument.

equals

public boolean equals(java.lang.Object obj)

Description copied from class: AbstractMP3FragmentBody

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

Overrides:

equals in class AbstractMP3FragmentBody

Parameters:

obj - object to determine equality of

Returns:

true if this object and its entire MP3Object array list equals the argument.

setupObjectList

protected void setupObjectList()

Description copied from class: AbstractMP3FragmentBody

Create the order of MP3Object objects that this body expects. This method needs to be overwritten.

Specified by:

setupObjectList in class AbstractMP3FragmentBody

read

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

Description copied from class: AbstractMP3FragmentBody

Read the data from the given file into this object. The file needs to have its file pointer in the correct location.

Overrides:

read in class AbstractMP3FragmentBody

Parameters:

file - file to read from

Throws:

java.io.IOException - on any I/O error

toString

public java.lang.String toString()

Description copied from class: AbstractMP3FragmentBody

Calls toString for all MP3Object objects and creates a string with a new line character.

Overrides:

toString in class AbstractMP3FragmentBody

Returns:

description string

write

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

Description copied from class: AbstractMP3FragmentBody

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

Overrides:

write in class AbstractMP3FragmentBody

Parameters:

file - destination file

Throws:

java.io.IOException - on any I/O error