org.blinkenlights.jid3.v2
Class SYTCID3V2Frame

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

public class SYTCID3V2Frame
extends ID3V2Frame

Frame containing synchronized tempo codes.


Nested Class Summary
static class SYTCID3V2Frame.TempoChange
          TempoChange class.
static class SYTCID3V2Frame.TimestampFormat
          Timestamp format.
 
Constructor Summary
SYTCID3V2Frame(java.io.InputStream oIS)
           
SYTCID3V2Frame(SYTCID3V2Frame.TimestampFormat oTimestampFormat)
          Creates a new instance of SYTCID3V2Frame.
 
Method Summary
 void accept(ID3Visitor oID3Visitor)
          Accept a visitor.
 void addTempoChange(SYTCID3V2Frame.TempoChange oTempoChange)
          Add a tempo change to the frame.
 boolean equals(java.lang.Object oOther)
           
protected  byte[] getFrameId()
          Get the four bytes which uniquely specify of which type this frame is.
 SYTCID3V2Frame.TempoChange getTempoChange(int iTimestamp)
          Get a tempo change from this frame.
 SYTCID3V2Frame.TempoChange removeTempoChange(int iTimestamp)
          Remove a tempo change from this 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

SYTCID3V2Frame

public SYTCID3V2Frame(SYTCID3V2Frame.TimestampFormat oTimestampFormat)
               throws ID3Exception
Creates a new instance of SYTCID3V2Frame.

Parameters:
oTimestampFormat - the timestamp format used in this frame
Throws:
ID3Exception - if oTimestampFormat is null

SYTCID3V2Frame

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

addTempoChange

public void addTempoChange(SYTCID3V2Frame.TempoChange oTempoChange)
                    throws ID3Exception
Add a tempo change to the frame.

Parameters:
oTempoChange - the tempo change to be added to this frame
Throws:
ID3Exception - if oTempoChange is null, or if a sync entry for this timestamp already exists in this frame

getTempoChange

public SYTCID3V2Frame.TempoChange getTempoChange(int iTimestamp)
Get a tempo change from this frame.

Parameters:
iTimestamp - the timestamp for which the sync entry should be returned
Returns:
the tempo change object matching the specified timestamp, or null if no matching tiemstamp exists

removeTempoChange

public SYTCID3V2Frame.TempoChange removeTempoChange(int iTimestamp)
Remove a tempo change from this frame.

Parameters:
iTimestamp - the timestamp for which the tempo change is to be removed
Returns:
the previously set sync entry for this timestamp, or null if no tempo change was set for this timestamp

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)