org.jaudiotagger.tag.id3.framebody
Class FrameBodyUFID

java.lang.Object
  extended by org.jaudiotagger.tag.id3.AbstractTagItem
      extended by org.jaudiotagger.tag.id3.AbstractTagFrameBody
          extended by org.jaudiotagger.tag.id3.framebody.AbstractID3v2FrameBody
              extended by org.jaudiotagger.tag.id3.framebody.FrameBodyUFID
All Implemented Interfaces:
ID3v23FrameBody, ID3v24FrameBody

public class FrameBodyUFID
extends AbstractID3v2FrameBody
implements ID3v24FrameBody, ID3v23FrameBody

A UFID Framebody consists of an owner that identifies the server hosting the unique identifier database, and the unique identifier itself which can be up to 64 bytes in length.


Field Summary
static java.lang.String UFID_ID3TEST
           
static java.lang.String UFID_MUSICBRAINZ
           
 
Fields inherited from class org.jaudiotagger.tag.id3.framebody.AbstractID3v2FrameBody
TYPE_BODY
 
Fields inherited from class org.jaudiotagger.tag.id3.AbstractTagFrameBody
objectList
 
Fields inherited from class org.jaudiotagger.tag.id3.AbstractTagItem
logger
 
Constructor Summary
FrameBodyUFID()
          Creates a new FrameBodyUFID datatype.
FrameBodyUFID(java.nio.ByteBuffer byteBuffer, int frameSize)
          Creates FrameBodyUFID datatype from buffer
FrameBodyUFID(FrameBodyUFID body)
           
FrameBodyUFID(java.lang.String owner, byte[] uniqueIdentifier)
          Creates a new FrameBodyUFID datatype.
 
Method Summary
 java.lang.String getIdentifier()
          The ID3v2 frame identifier
 java.lang.String getOwner()
           
 byte[] getUniqueIdentifier()
           
 void setOwner(java.lang.String owner)
          Set the owner of url of the the database that this ufid is stored in
 void setUniqueIdentifier(byte[] uniqueIdentifier)
          Set the unique identifier (within the owners domain)
protected  void setupObjectList()
          Create the list of Datatypes that this body expects in the correct order This method needs to be implemented by concrete subclasses
 
Methods inherited from class org.jaudiotagger.tag.id3.framebody.AbstractID3v2FrameBody
createStructure, equals, getSize, read, setSize, setSize, write
 
Methods inherited from class org.jaudiotagger.tag.id3.AbstractTagFrameBody
getBriefDescription, getHeader, getLongDescription, getObject, getObjectValue, getTextEncoding, isSubsetOf, iterator, setHeader, setObjectValue, setTextEncoding, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

UFID_MUSICBRAINZ

public static final java.lang.String UFID_MUSICBRAINZ
See Also:
Constant Field Values

UFID_ID3TEST

public static final java.lang.String UFID_ID3TEST
See Also:
Constant Field Values
Constructor Detail

FrameBodyUFID

public FrameBodyUFID()
Creates a new FrameBodyUFID datatype.


FrameBodyUFID

public FrameBodyUFID(FrameBodyUFID body)

FrameBodyUFID

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

Parameters:
owner - url of the database
uniqueIdentifier - unique identifier

FrameBodyUFID

public FrameBodyUFID(java.nio.ByteBuffer byteBuffer,
                     int frameSize)
              throws InvalidTagException
Creates FrameBodyUFID datatype from buffer

Parameters:
byteBuffer -
frameSize -
Throws:
InvalidTagException
Method Detail

getIdentifier

public java.lang.String getIdentifier()
The ID3v2 frame identifier

Specified by:
getIdentifier in class AbstractID3v2FrameBody
Returns:
the ID3v2 frame identifier for this frame type

setOwner

public void setOwner(java.lang.String owner)
Set the owner of url of the the database that this ufid is stored in

Parameters:
owner - should be a valid url

getOwner

public java.lang.String getOwner()
Returns:
the url of the the database that this ufid is stored in

setUniqueIdentifier

public void setUniqueIdentifier(byte[] uniqueIdentifier)
Set the unique identifier (within the owners domain)

Parameters:
uniqueIdentifier -

getUniqueIdentifier

public byte[] getUniqueIdentifier()
Returns:
the unique identifier (within the owners domain)

setupObjectList

protected void setupObjectList()
Description copied from class: AbstractTagFrameBody
Create the list of Datatypes that this body expects in the correct order This method needs to be implemented by concrete subclasses

Specified by:
setupObjectList in class AbstractTagFrameBody