org.blinkenlights.jid3.v2
Class PRIVID3V2Frame

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

public class PRIVID3V2Frame
extends ID3V2Frame

Frame containing private information.


Constructor Summary
PRIVID3V2Frame(java.io.InputStream oIS)
           
PRIVID3V2Frame(java.lang.String sOwnerIdentifier, byte[] abyPrivateData)
          Creates a new instance of PRIVID3V2Frame
 
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.
 java.lang.String getOwnerIdentifier()
          Get the owner identifier.
 byte[] getPrivateData()
          Get private data.
 void setPrivateInformation(java.lang.String sOwnerIdentifier, byte[] abyPrivateData)
          Set private information.
 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

PRIVID3V2Frame

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

Parameters:
sOwnerIdentifier - an URL or email address identifier the owner related to the private data
abyPrivateData - the private data to be stored in this frame
Throws:
ID3Exception - if the owner identifier is null or zero length, or if the private data is null

PRIVID3V2Frame

public PRIVID3V2Frame(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

setPrivateInformation

public void setPrivateInformation(java.lang.String sOwnerIdentifier,
                                  byte[] abyPrivateData)
                           throws ID3Exception
Set private information.

Parameters:
sOwnerIdentifier - an URL or email address identifier the owner related to the private data
abyPrivateData - the private data to be stored in this frame
Throws:
ID3Exception - if the owner identifier is null or zero length, or if the private data is null
ID3Exception - if this frame is in a tag with another PRIV frame which would have the same contents

getOwnerIdentifier

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

Returns:
an identification string for the owner associated with the private data in this frame

getPrivateData

public byte[] getPrivateData()
Get private data.

Returns:
the private data stored in this frame

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)