org.blinkenlights.jid3.v2
Class TPOSTextInformationID3V2Frame

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

public class TPOSTextInformationID3V2Frame
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
TPOSTextInformationID3V2Frame(java.io.InputStream oIS)
           
TPOSTextInformationID3V2Frame(int iPartNumber)
          Constructor.
TPOSTextInformationID3V2Frame(int iPartNumber, int iTotalParts)
          Constructor.
 
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 getPartNumber()
          Get the part number in the set to which this recording belongs.
 TextEncoding getTextEncoding()
          Get the text encoding used for the text information in this frame.
 int getTotalParts()
          Get the total number of parts in the complete set to which this recording belongs.
 void setPartNumber(int iPartNumber)
          Set the part number in the set to which this recording belongs.
 void setPartNumberAndTotalParts(int iPartNumber, int iTotalParts)
          Set the part number in the set to which this recording belongs, and the total number of parts in the complete set.
 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

TPOSTextInformationID3V2Frame

public TPOSTextInformationID3V2Frame(int iPartNumber)
                              throws ID3Exception
Constructor.

Parameters:
iPartNumber - the part number in the set to which this recording belongs
Throws:
ID3Exception - if the part number is negative

TPOSTextInformationID3V2Frame

public TPOSTextInformationID3V2Frame(int iPartNumber,
                                     int iTotalParts)
                              throws ID3Exception
Constructor.

Parameters:
iPartNumber - the part number in the set to which this recording belongs
iTotalParts - the total number of parts in the complete set
Throws:
ID3Exception - if the part number is negative, or the total number of parts is less than the part number

TPOSTextInformationID3V2Frame

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

setPartNumber

public void setPartNumber(int iPartNumber)
                   throws ID3Exception
Set the part number in the set to which this recording belongs.

Parameters:
iPartNumber - the part number in the set to which this recording belongs
Throws:
ID3Exception - if the part number is negative

setPartNumberAndTotalParts

public void setPartNumberAndTotalParts(int iPartNumber,
                                       int iTotalParts)
                                throws ID3Exception
Set the part number in the set to which this recording belongs, and the total number of parts in the complete set.

Parameters:
iPartNumber - the part number in the set to which this recording belongs
iTotalParts - the total number of parts in a complete set
Throws:
ID3Exception - if the part number is negative, or the total number of parts is less than the part number

getPartNumber

public int getPartNumber()
Get the part number in the set to which this recording belongs.

Returns:
the part number in the set to which this recording belongs

getTotalParts

public int getTotalParts()
Get the total number of parts in the complete set to which this recording belongs.

Returns:
the total number of parts in the complete set to which this recording belongs, or -1 if the total number of parts has not been specified

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

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

writeBody

protected void writeBody(ID3DataOutputStream oIDOS)
                  throws java.io.IOException
Write the body of this frame to an output stream.

Specified by:
writeBody in class ID3V2Frame
Parameters:
oIDOS - the ID3 output stream to which the frame body is to be written
Throws:
ID3Exception - if there is any error writing the frame body data
java.io.IOException