|
|||||||||||
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.COMMID3V2Frame
Constructor Summary | |
COMMID3V2Frame(java.io.InputStream oIS)
|
|
COMMID3V2Frame(java.lang.String sLanguage,
java.lang.String sShortDescription,
java.lang.String sActualText)
Constructor. |
Method Summary | |
void |
accept(ID3Visitor oID3Visitor)
Accept a visitor. |
boolean |
equals(java.lang.Object oOther)
|
java.lang.String |
getActualText()
Get the actual text of the comment. |
protected byte[] |
getFrameId()
Get the four bytes which uniquely specify of which type this frame is. |
java.lang.String |
getLanguage()
Get the language of this comment. |
java.lang.String |
getShortDescription()
Get the short description of this comment. |
TextEncoding |
getTextEncoding()
Get the text encoding used for the short description and actual text in this frame. |
void |
setComment(java.lang.String sLanguage,
java.lang.String sShortDescription,
java.lang.String sActualText)
Set the language of this comment. |
void |
setLanguage(java.lang.String sLanguage)
Set the language of this comment. |
void |
setTextEncoding(TextEncoding oTextEncoding)
Set the text encoding to be used for the short description and actual text in 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 COMMID3V2Frame(java.lang.String sLanguage, java.lang.String sShortDescription, java.lang.String sActualText) throws ID3Exception
sLanguage
- three letter language code for this commentsShortDescription
- a short description of this comment (null or zero-length string for no description)sActualText
- the actual text of the comment
ID3Exception
- if the language code is not three characters in length
ID3Exception
- if the actual text is nullpublic COMMID3V2Frame(java.io.InputStream oIS) throws ID3Exception
Method Detail |
public void accept(ID3Visitor oID3Visitor)
ID3Visitable
oID3Visitor
- a visitor of this objectpublic void setComment(java.lang.String sLanguage, java.lang.String sShortDescription, java.lang.String sActualText) throws ID3Exception
sLanguage
- three letter language code for this commentsShortDescription
- a short description of this comment (null or zero-length string for no description)sActualText
- the actual text of the comment
ID3Exception
- if the language code is not three characters in length
ID3Exception
- if the actual text is null
ID3Exception
- if this frame is in a tag with another COMM frame which would have the same language and short descriptionpublic void setTextEncoding(TextEncoding oTextEncoding)
oTextEncoding
- the text encoding to be used for this framepublic TextEncoding getTextEncoding()
public void setLanguage(java.lang.String sLanguage) throws ID3Exception
sLanguage
- the language of the comment
ID3Exception
public java.lang.String getLanguage()
public java.lang.String getShortDescription()
public java.lang.String getActualText()
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 |