org.blinkenlights.jid3.v2
Class PCNTID3V2Frame

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

public class PCNTID3V2Frame
extends ID3V2Frame

Frame containing a play counter. Note: There is no support for counter values greater than a 32-bit signed int. Will any track ever get played more than 2 billion times?


Constructor Summary
PCNTID3V2Frame(java.io.InputStream oIS)
           
PCNTID3V2Frame(int iPlayCount)
          Creates a new instance of PCNTID3V2Frame
 
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.
 int getPlayCount()
          Get play count.
 void setPlayCount(int iPlayCount)
          Set the play count.
 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

PCNTID3V2Frame

public PCNTID3V2Frame(int iPlayCount)
               throws ID3Exception
Creates a new instance of PCNTID3V2Frame

Parameters:
iPlayCount - the current play count for this track
Throws:
ID3Exception - if the play count specified is negative

PCNTID3V2Frame

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

setPlayCount

public void setPlayCount(int iPlayCount)
                  throws ID3Exception
Set the play count.

Parameters:
iPlayCount - the current play count for this track
Throws:
ID3Exception - if the play count specified is negative

getPlayCount

public int getPlayCount()
Get play count.

Returns:
the play count

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)