org.blinkenlights.jid3.v2
Class EQUAID3V2Frame

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

public class EQUAID3V2Frame
extends ID3V2Frame


Nested Class Summary
 class EQUAID3V2Frame.Adjustment
          Adjustment details for specific frequencies in EQUA frame.
 
Constructor Summary
EQUAID3V2Frame(byte byAdjustmentBits)
          Constructor.
EQUAID3V2Frame(java.io.InputStream oIS)
           
 
Method Summary
 void accept(ID3Visitor oID3Visitor)
          Accept a visitor.
 boolean equals(java.lang.Object oOther)
           
 EQUAID3V2Frame.Adjustment getAdjustment(int iFrequency)
          Get the currently set adjustment for a given frequency.
 byte getAdjustmentBits()
          Get the number of bits of precision for each adjustment.
 EQUAID3V2Frame.Adjustment[] getAdjustments()
          Get all adjustments which have been set.
protected  byte[] getFrameId()
          Get the four bytes which uniquely specify of which type this frame is.
 EQUAID3V2Frame.Adjustment removeAdjustment(int iFrequency)
          Remove an existing adjustment.
 void setAdjustment(EQUAID3V2Frame.Adjustment oAdjustment)
          Set an adjustment for a given frequency.
 void setAdjustmentBits(byte byAdjustmentBits)
          Set the number of bits of precision for each adjustment.
 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

EQUAID3V2Frame

public EQUAID3V2Frame(byte byAdjustmentBits)
Constructor.

Parameters:
byAdjustmentBits - the number of bits of precision each adjustment contains

EQUAID3V2Frame

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

setAdjustmentBits

public void setAdjustmentBits(byte byAdjustmentBits)
Set the number of bits of precision for each adjustment.

Parameters:
byAdjustmentBits - the number of bits of precision

getAdjustmentBits

public byte getAdjustmentBits()
Get the number of bits of precision for each adjustment.

Returns:
the number of bits of precision

setAdjustment

public void setAdjustment(EQUAID3V2Frame.Adjustment oAdjustment)
Set an adjustment for a given frequency. A new adjustment for a given frequency will replace any existing one.

Parameters:
oAdjustment - the adjustment to be set

getAdjustment

public EQUAID3V2Frame.Adjustment getAdjustment(int iFrequency)
                                        throws ID3Exception
Get the currently set adjustment for a given frequency.

Returns:
the set adjustment for the given frequency, or null if no adjustment has been set for it
Throws:
ID3Exception - if the frequency specified is outside the range from 0-32767Hz

removeAdjustment

public EQUAID3V2Frame.Adjustment removeAdjustment(int iFrequency)
                                           throws ID3Exception
Remove an existing adjustment.

Parameters:
iFrequency - the frequency of the adjustment to remove
Returns:
the removed adjustment, or null if no adjustment was set at the specified frequency
Throws:
ID3Exception - if the frequency specified is outside the range from 0-32767Hz

getAdjustments

public EQUAID3V2Frame.Adjustment[] getAdjustments()
Get all adjustments which have been set.

Returns:
an array of all adjustments which have been set

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)