org.blinkenlights.jid3.v2
Class USERID3V2Frame

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

public class USERID3V2Frame
extends ID3V2Frame

Frame containing terms of use information.


Constructor Summary
USERID3V2Frame(java.io.InputStream oIS)
           
USERID3V2Frame(java.lang.String sLanguage, java.lang.String sTermsOfUse)
          Creates a new instance of USERID3V2Frame.
 
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.
 java.lang.String getLanguage()
          Get the language of the terms of use.
 java.lang.String getTermsOfUse()
          Get the terms of use for this file.
 TextEncoding getTextEncoding()
          Get the text encoding used for the terms of use in this frame.
 void setTermsOfUse(java.lang.String sLanguage, java.lang.String sTermsOfUse)
          Set the terms of use.
 void setTextEncoding(TextEncoding oTextEncoding)
          Set the text encoding to be used for the terms of use 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

USERID3V2Frame

public USERID3V2Frame(java.lang.String sLanguage,
                      java.lang.String sTermsOfUse)
               throws ID3Exception
Creates a new instance of USERID3V2Frame.

Parameters:
sLanguage - a three character code specifying the language of the terms of use
sTermsOfUse - the terms of use for this recording or file
Throws:
ID3Exception - if the language is not in a valid format, or if the terms of use are not specified

USERID3V2Frame

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

setTermsOfUse

public void setTermsOfUse(java.lang.String sLanguage,
                          java.lang.String sTermsOfUse)
                   throws ID3Exception
Set the terms of use.

Parameters:
sLanguage - a three character code specifying the language of the terms of use
sTermsOfUse - the terms of use for this recording or file
Throws:
ID3Exception - if the language is not in a valid format, or if the terms of use are not specified

getLanguage

public java.lang.String getLanguage()
Get the language of the terms of use.

Returns:
the three letter language code

getTermsOfUse

public java.lang.String getTermsOfUse()
Get the terms of use for this file.

Returns:
the terms of use

setTextEncoding

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

Returns:
the text encoding to be used for 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: 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)