|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.blinkenlights.jid3.v2.ID3V2Frame
org.blinkenlights.jid3.v2.POPMID3V2Frame
Frame containing a popularimeter.
Constructor Summary | |
POPMID3V2Frame(java.io.InputStream oIS)
|
|
POPMID3V2Frame(java.lang.String sEmailToUser,
int iPopularity)
Creates a new instance of POPMID3V2Frame, not specifying the play count value. |
|
POPMID3V2Frame(java.lang.String sEmailToUser,
int iPopularity,
int iPlayCount)
Creates a new instance of POPMID3V2Frame. |
Method Summary | |
void |
accept(ID3Visitor oID3Visitor)
Accept a visitor. |
boolean |
equals(java.lang.Object oOther)
|
java.lang.String |
getEmailToUser()
Get the email address of the user to be informed about the popularity of this track. |
protected byte[] |
getFrameId()
Get the four bytes which uniquely specify of which type this frame is. |
int |
getPlayCount()
Get the play count value for this track. |
int |
getPopularity()
Get the popularity rating of this track (1=worst, 255=best, 0=unknown) |
void |
setPopularity(java.lang.String sEmailToUser,
int iPopularity)
Set the popularity values for this frame, not specifying a play count value. |
void |
setPopularity(java.lang.String sEmailToUser,
int iPopularity,
int iPlayCount)
Set the popularity values for 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 |
public POPMID3V2Frame(java.lang.String sEmailToUser, int iPopularity, int iPlayCount) throws ID3Exception
sEmailToUser
- the email address of the user to be informed of this track's popularityiPopularity
- the popularity rating of this track (1=worst, 255=best, 0=unknown)iPlayCount
- the current playcount of this file (must be positive)
ID3Exception
- if sEmailToUser not provided, or if either iPopularity or iPlayCount values are out of rangepublic POPMID3V2Frame(java.lang.String sEmailToUser, int iPopularity) throws ID3Exception
sEmailToUser
- the email address of the user to be informed of this track's popularityiPopularity
- the popularity rating of this track (1=worst, 255=best, 0=unknown)
ID3Exception
- if sEmailToUser not provided, or if either iPopularity or iPlayCount values are out of rangepublic POPMID3V2Frame(java.io.InputStream oIS) throws ID3Exception
Method Detail |
public void accept(ID3Visitor oID3Visitor)
ID3Visitable
oID3Visitor
- a visitor of this objectpublic void setPopularity(java.lang.String sEmailToUser, int iPopularity, int iPlayCount) throws ID3Exception
sEmailToUser
- the email address of the user to be informed of this track's popularityiPopularity
- the popularity rating of this track (1=worst, 255=best, 0=unknown)iPlayCount
- the current playcount of this file (must be positive)
ID3Exception
- if sEmailToUser not provided, or if either iPopularity or iPlayCount values are out of range
ID3Exception
- if this frame is in a tag with another POPM frame which would have the same email addresspublic void setPopularity(java.lang.String sEmailToUser, int iPopularity) throws ID3Exception
sEmailToUser
- the email address of the user to be informed of this track's popularityiPopularity
- the popularity rating of this track (1=worst, 255=best, 0=unknown)
ID3Exception
- if sEmailToUser not provided, or if either iPopularity or iPlayCount values are out of range
ID3Exception
- if this frame is in a tag with another AENC frame which would have the same email addresspublic java.lang.String getEmailToUser()
public int getPopularity()
public int getPlayCount()
protected byte[] getFrameId()
ID3V2Frame
getFrameId
in class ID3V2Frame
public java.lang.String toString()
ID3V2Frame
toString
in class ID3V2Frame
protected void writeBody(ID3DataOutputStream oIDOS) throws java.io.IOException
ID3V2Frame
writeBody
in class ID3V2Frame
oIDOS
- the output stream to write to
java.io.IOException
public boolean equals(java.lang.Object oOther)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |