org.blinkenlights.jid3.v2
Class UFIDID3V2Frame

java.lang.Object
  extended byorg.blinkenlights.jid3.v2.ID3V2Frame
      extended byorg.blinkenlights.jid3.v2.UFIDID3V2Frame
All Implemented Interfaces:
ID3Subject, ID3Visitable

public class UFIDID3V2Frame
extends ID3V2Frame

Frame containing a unique file identifier.


Constructor Summary
UFIDID3V2Frame(java.io.InputStream oIS)
           
UFIDID3V2Frame(java.lang.String sOwnerIdentifier, byte[] abyIdentifier)
          Creates a new instance of UFIDID3V2Frame.
 
Method Summary
 void accept(ID3Visitor oID3Visitor)
          Accept a visitor.
 boolean equals(java.lang.Object oOther)
           
protected  byte[] getFrameId()
          Get the four bytes which uniquely specify of which type this frame is.
 byte[] getIdentifier()
          Get the unique file identifier from this frame
 java.lang.String getOwnerIdentifier()
          Get the owner identifier for this frame.
 void setUniqueIdentifier(java.lang.String sOwnerIdentifier, byte[] abyIdentifier)
          Set unique file identifier.
 java.lang.String toString()
          Represent the contents of this frame as a string.
protected  void writeBody(ID3DataOutputStream oIDOS)
          Write the body of the frame to an ID3 data output stream.
 
Methods inherited from class org.blinkenlights.jid3.v2.ID3V2Frame
addID3Observer, getEncryptionMethod, isEncrypted, notifyID3Observers, removeID3Observer, setCompressionFlag, setEncryption, setFileAlterPreservationFlag, setGroupingIdentityFlag, setReadOnlyFlag, setTagAlterPreservationFlag, write, writeHeader
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UFIDID3V2Frame

public UFIDID3V2Frame(java.lang.String sOwnerIdentifier,
                      byte[] abyIdentifier)
               throws ID3Exception
Creates a new instance of UFIDID3V2Frame.

Parameters:
sOwnerIdentifier - an URL or email address identifying the owner of this file
abyIdentifier - up to 64 bytes of data which uniquely identify this file
Throws:
ID3Exception - if sOwnerIdentifier is null or zero length, or if abyIdentifier is null or of length outside the range from 0-64

UFIDID3V2Frame

public UFIDID3V2Frame(java.io.InputStream oIS)
               throws ID3Exception
Method Detail

accept

public void accept(ID3Visitor oID3Visitor)
Description copied from interface: ID3Visitable
Accept a visitor.

Parameters:
oID3Visitor - a visitor of this object

setUniqueIdentifier

public void setUniqueIdentifier(java.lang.String sOwnerIdentifier,
                                byte[] abyIdentifier)
                         throws ID3Exception
Set unique file identifier.

Parameters:
sOwnerIdentifier - an URL or email address identifying the owner of this file
abyIdentifier - up to 64 bytes of data which uniquely identify this file
Throws:
ID3Exception - if sOwnerIdentifier is null or zero length, or if abyIdentifier is null or of length outside the range from 0-64, or if this frame is in a tag with another UFID frame which has the same owner identifier

getOwnerIdentifier

public java.lang.String getOwnerIdentifier()
Get the owner identifier for this frame.

Returns:
the owner identifier

getIdentifier

public byte[] getIdentifier()
Get the unique file identifier from this frame

Returns:
the unique file identifier

getFrameId

protected byte[] getFrameId()
Description copied from class: ID3V2Frame
Get the four bytes which uniquely specify of which type this frame is.

Specified by:
getFrameId in class ID3V2Frame

toString

public java.lang.String toString()
Description copied from class: ID3V2Frame
Represent the contents of this frame as a string. For debugging purposes.

Specified by:
toString in class ID3V2Frame
Returns:
a string representing this frame

writeBody

protected void writeBody(ID3DataOutputStream oIDOS)
                  throws java.io.IOException
Description copied from class: ID3V2Frame
Write the body of the frame to an ID3 data output stream.

Specified by:
writeBody in class ID3V2Frame
Parameters:
oIDOS - the output stream to write to
Throws:
java.io.IOException

equals

public boolean equals(java.lang.Object oOther)