org.farng.mp3.id3
Class FrameBodyUFID

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

public class FrameBodyUFID
extends AbstractID3v2FrameBody

4.1.   Unique file identifier

   This frame's purpose is to be able to identify the audio file in a
   database, that may provide more information relevant to the content.
   Since standardisation of such a database is beyond this document, all

   UFID frames begin with an 'owner identifier' field. It is a null-
   terminated string with a URL [URL] containing an email address, or a
   link to a location where an email address can be found, that belongs
   to the organisation responsible for this specific database
   implementation. Questions regarding the database should be sent to

   the indicated email address. The URL should not be used for the
   actual database queries. The string
   "http://www.id3.org/dummy/ufid.html" should be used for tests. The
   'Owner identifier' must be non-empty (more than just a termination).

   The 'Owner identifier' is then followed by the actual identifier,
   which may be up to 64 bytes. There may be more than one "UFID" frame
   in a tag, but only one with the same 'Owner identifier'.

     <Header for 'Unique file identifier', ID: "UFID">
     Owner identifier        <text string> $00
     Identifier             

<up to 64 bytes binary data>

Version:
$Revision: 1.4 $
Author:
Eric Farng

Constructor Summary
FrameBodyUFID()
          Creates a new FrameBodyUFID object.
FrameBodyUFID(FrameBodyUFID body)
          Creates a new FrameBodyUFID object.
FrameBodyUFID(java.io.RandomAccessFile file)
          Creates a new FrameBodyUFID object.
FrameBodyUFID(java.lang.String owner, byte[] identifier)
          Creates a new FrameBodyUFID object.
 
Method Summary
 java.lang.String getIdentifier()
          ID string that usually corresponds to the class name, but can be displayed to the user.
 java.lang.String getOwner()
           
 void setOwner(java.lang.String owner)
           
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, getDescription, 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

FrameBodyUFID

public FrameBodyUFID()
Creates a new FrameBodyUFID object.


FrameBodyUFID

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


FrameBodyUFID

public FrameBodyUFID(java.lang.String owner,
                     byte[] identifier)
Creates a new FrameBodyUFID object.


FrameBodyUFID

public FrameBodyUFID(java.io.RandomAccessFile file)
              throws java.io.IOException,
                     InvalidTagException
Creates a new FrameBodyUFID 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

setOwner

public void setOwner(java.lang.String owner)

getOwner

public java.lang.String getOwner()

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