org.blinkenlights.jid3.v2
Class ENCRID3V2Frame

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

public class ENCRID3V2Frame
extends ID3V2Frame


Constructor Summary
ENCRID3V2Frame(java.io.InputStream oIS)
           
ENCRID3V2Frame(java.lang.String sOwnerIdentifier, byte byMethodSymbol, byte[] abyEncryptionData)
          Constructor.
 
Method Summary
 void accept(ID3Visitor oID3Visitor)
          Accept a visitor.
 boolean equals(java.lang.Object oOther)
           
 byte[] getEncryptionData()
          Get additional encryption data for this method.
 byte getEncryptionMethodSymbol()
          Get the symbol used for this encryption method in this file.
protected  byte[] getFrameId()
          Get the four bytes which uniquely specify of which type this frame is.
 java.lang.String getOwnerIdentifier()
          Get the owner identifier for this encryption method.
 void setEncryptionDetails(java.lang.String sOwnerIdentifier, byte byMethodSymbol, byte[] abyEncryptionData)
          Set details for this encryption frame.
 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

ENCRID3V2Frame

public ENCRID3V2Frame(java.lang.String sOwnerIdentifier,
                      byte byMethodSymbol,
                      byte[] abyEncryptionData)
               throws ID3Exception
Constructor.

Parameters:
sOwnerIdentifier - an URL or email address where decryption details can be found
byMethodSymbol - a symbol which can be used to identify this encryption method in this file (methods below 0x80 are reserved)
abyEncryptionData - any optional required data for this encryption method
Throws:
ID3Exception - if sOwnerIdentifier is null

ENCRID3V2Frame

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

setEncryptionDetails

public void setEncryptionDetails(java.lang.String sOwnerIdentifier,
                                 byte byMethodSymbol,
                                 byte[] abyEncryptionData)
                          throws ID3Exception
Set details for this encryption frame.

Parameters:
sOwnerIdentifier - an URL or email address where decryption details can be found
byMethodSymbol - a symbol which can be used to identify this encryption method in this file
abyEncryptionData - any optional required data for this encryption method
Throws:
ID3Exception - if sOwnerIdentifier is null
ID3Exception - if this frame is in a tag with another ENCR frame which would have the method symbol

getOwnerIdentifier

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

Returns:
the owner identifier, which should be an URL or email address

getEncryptionMethodSymbol

public byte getEncryptionMethodSymbol()
Get the symbol used for this encryption method in this file.

Returns:
the unique encryption method symbol

getEncryptionData

public byte[] getEncryptionData()
Get additional encryption data for this method.

Returns:
additional encryption data, or null if none was provided

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)