org.blinkenlights.jid3.v2
Class TXXXTextInformationID3V2Frame

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

public class TXXXTextInformationID3V2Frame
extends org.blinkenlights.jid3.v2.TextInformationID3V2Frame


Field Summary
protected  TextEncoding m_oTextEncoding
          The text encoding of the strings in this frame.
protected  java.lang.String m_sInformation
          The text content of this frame.
 
Constructor Summary
TXXXTextInformationID3V2Frame(java.io.InputStream oIS)
           
TXXXTextInformationID3V2Frame(java.lang.String sDescription, java.lang.String sInformation)
          Constructor.
 
Method Summary
 void accept(ID3Visitor oID3Visitor)
          Accept a visitor.
 boolean equals(java.lang.Object oOther)
           
 java.lang.String getDescription()
          Get the description of the information stored in this frame.
protected  byte[] getFrameId()
          Get the four bytes which uniquely specify of which type this frame is.
 java.lang.String getInformation()
          Get the information stored in this frame.
 TextEncoding getTextEncoding()
          Get the text encoding used for the text information in this frame.
 void setDescriptionAndInformation(java.lang.String sDescription, java.lang.String sInformation)
          Set the description of the information to be stored in this frame, along with the actual information.
 void setTextEncoding(TextEncoding oTextEncoding)
          Set the text encoding to be used for the text information 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 this frame to an 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
 

Field Detail

m_oTextEncoding

protected TextEncoding m_oTextEncoding
The text encoding of the strings in this frame.


m_sInformation

protected java.lang.String m_sInformation
The text content of this frame. Based on the type of frame, there will be different meanings, and potentailly unique restrictions, for this value.

Constructor Detail

TXXXTextInformationID3V2Frame

public TXXXTextInformationID3V2Frame(java.lang.String sDescription,
                                     java.lang.String sInformation)
                              throws ID3Exception
Constructor.

Parameters:
sDescription - a description of the information being stored
sInformation - the information being stored
Throws:
ID3Exception - if either the description or information are empty

TXXXTextInformationID3V2Frame

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

setDescriptionAndInformation

public void setDescriptionAndInformation(java.lang.String sDescription,
                                         java.lang.String sInformation)
                                  throws ID3Exception
Set the description of the information to be stored in this frame, along with the actual information.

Parameters:
sDescription - a description of the information being stored
sInformation - the information being stored
Throws:
ID3Exception - if either the description or information are empty, or if this TXXX frame is stored in a tag where there is another TXXX frame with the same description

getDescription

public java.lang.String getDescription()
Get the description of the information stored in this frame.

Returns:
the description of the information stored in this frame

getInformation

public java.lang.String getInformation()
Get the information stored in this frame.

Returns:
the information stored in this frame

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: org.blinkenlights.jid3.v2.TextInformationID3V2Frame
Write the body of this frame to an output stream.

Parameters:
oIDOS - the ID3 output stream to which the frame body is to be written
Throws:
java.io.IOException

equals

public boolean equals(java.lang.Object oOther)

setTextEncoding

public void setTextEncoding(TextEncoding oTextEncoding)
Set the text encoding to be used for the text information 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 text information in this frame.

Returns:
the text encoding to be used for this frame