org.farng.mp3.id3
Class FrameBodyGEOB

java.lang.Object
  extended byorg.farng.mp3.AbstractMP3FileItem
      extended byorg.farng.mp3.AbstractMP3FragmentBody
          extended byorg.farng.mp3.id3.AbstractID3v2FrameBody
              extended byorg.farng.mp3.id3.FrameBodyGEOB

public class FrameBodyGEOB
extends AbstractID3v2FrameBody

4.15.   General encapsulated object

   In this frame any type of file can be encapsulated. After the header,
   'Frame size' and 'Encoding' follows 'MIME type' [MIME] represented as
   as a terminated string encoded with ISO 8859-1 [ISO-8859-1]. The
   filename is case sensitive and is encoded as 'Encoding'. Then follows

   a content description as terminated string, encoded as 'Encoding'.
   The last thing in the frame is the actual object. The first two
   strings may be omitted, leaving only their terminations. MIME type is
   always an ISO-8859-1 text string. There may be more than one "GEOB"

   frame in each tag, but only one with the same content descriptor.

     <Header for 'General encapsulated object', ID: "GEOB">
     Text encoding          $xx
     MIME type             

<text string> $00
     Filename               <text string according to encoding> $00 (00)
     Content description    <text string according to encoding> $00 (00)

     Encapsulated object    <binary data>

Version:
$Revision: 1.4 $
Author:
Eric Farng

Constructor Summary
FrameBodyGEOB()
          Creates a new FrameBodyGEOB object.
FrameBodyGEOB(byte textEncoding, java.lang.String mimeType, java.lang.String filename, java.lang.String description, byte[] object)
          Creates a new FrameBodyGEOB object.
FrameBodyGEOB(FrameBodyGEOB body)
          Creates a new FrameBodyGEOB object.
FrameBodyGEOB(java.io.RandomAccessFile file)
          Creates a new FrameBodyGEOB object.
 
Method Summary
 java.lang.String getDescription()
          This method calls toString for all it's objects and appends them.
 java.lang.String getIdentifier()
          ID string that usually corresponds to the class name, but can be displayed to the user.
 void setDescription(java.lang.String description)
           
protected  void setupObjectList()
          Create the order of MP3Object objects that this body expects.
 
Methods inherited from class org.farng.mp3.id3.AbstractID3v2FrameBody
equals, readHeader, writeHeader
 
Methods inherited from class org.farng.mp3.AbstractMP3FragmentBody
appendToObjectList, getBriefDescription, getObject, getObjectListIterator, getSize, has6ByteHeader, isSubsetOf, iterator, read, setObject, toString, write
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FrameBodyGEOB

public FrameBodyGEOB()
Creates a new FrameBodyGEOB object.


FrameBodyGEOB

public FrameBodyGEOB(FrameBodyGEOB body)
Creates a new FrameBodyGEOB object.


FrameBodyGEOB

public FrameBodyGEOB(byte textEncoding,
                     java.lang.String mimeType,
                     java.lang.String filename,
                     java.lang.String description,
                     byte[] object)
Creates a new FrameBodyGEOB object.


FrameBodyGEOB

public FrameBodyGEOB(java.io.RandomAccessFile file)
              throws java.io.IOException,
                     InvalidTagException
Creates a new FrameBodyGEOB object.

Method Detail

setDescription

public void setDescription(java.lang.String description)

getDescription

public java.lang.String getDescription()
Description copied from class: AbstractMP3FragmentBody
This method calls toString for all it's objects and appends them. It contains new line characters and is more suited for display purposes

Overrides:
getDescription in class AbstractMP3FragmentBody
Returns:
formatted description string

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

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


Copyright (c) 2004 Eric Farng