org.blinkenlights.jid3.v2
Class COMMID3V2Frame

java.lang.Object
  org.blinkenlights.jid3.v2.ID3V2Frame
      org.blinkenlights.jid3.v2.COMMID3V2Frame

All Implemented Interfaces:

ID3Subject, ID3Visitable

public class COMMID3V2Frame

extends ID3V2Frame

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

COMMID3V2Frame

public COMMID3V2Frame(java.lang.String sLanguage,
                      java.lang.String sShortDescription,
                      java.lang.String sActualText)
               throws ID3Exception

Constructor.

Parameters:

sLanguage - three letter language code for this comment

sShortDescription - a short description of this comment (null or zero-length string for no description)

sActualText - the actual text of the comment

Throws:

ID3Exception - if the language code is not three characters in length

ID3Exception - if the actual text is null

COMMID3V2Frame

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

setComment

public void setComment(java.lang.String sLanguage,
                       java.lang.String sShortDescription,
                       java.lang.String sActualText)
                throws ID3Exception

Set the language of this comment.

Parameters:

sLanguage - three letter language code for this comment

sShortDescription - a short description of this comment (null or zero-length string for no description)

sActualText - the actual text of the comment

Throws:

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 description

setTextEncoding

public void setTextEncoding(TextEncoding oTextEncoding)

Set the text encoding to be used for the short description and actual text in this frame.

Parameters:

oTextEncoding - the text encoding to be used for this frame

getTextEncoding

public TextEncoding getTextEncoding()

Get the text encoding used for the short description and actual text in this frame.

Returns:

the text encoding to be used for this frame

setLanguage

public void setLanguage(java.lang.String sLanguage)
                 throws ID3Exception

Set the language of this comment.

Parameters:

sLanguage - the language of the comment

Throws:

ID3Exception

getLanguage

public java.lang.String getLanguage()

Get the language of this comment.

Returns:

a three letter code defining the language used

getShortDescription

public java.lang.String getShortDescription()

Get the short description of this comment.

Returns:

the short description of this comment

getActualText

public java.lang.String getActualText()

Get the actual text of the comment.

Returns:

the actual text of the comment

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)