de.vdheide.mp3
Class TextFrame

java.lang.Object
  extended byde.vdheide.mp3.TextFrame
Direct Known Subclasses:
TextFrameEncoding, TextFrameNoEncoding

public abstract class TextFrame
extends java.lang.Object

Used for text ID3v2 frames. Supports get and set operations


Constructor Summary
TextFrame(boolean encoding, ID3v2 id3v2, java.lang.String type, TagContent content, boolean use_compression)
          Creates a new TextFrame with a given content
 
Method Summary
static TagContent read(boolean encoding, ID3v2 id3v2, java.lang.String type)
          Read content from ID3v2 tag.
 void write()
          Write frame to ID3v2 tag
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TextFrame

public TextFrame(boolean encoding,
                 ID3v2 id3v2,
                 java.lang.String type,
                 TagContent content,
                 boolean use_compression)
          throws TagFormatException
Creates a new TextFrame with a given content

Parameters:
encoding - Use encoding?
id3v2 - ID3v2 tag
type - Type of frame
content - TagContent to write
use_compression - Use compression?
Throws:
TagFormatException - If text content field is null
Method Detail

write

public void write()
Write frame to ID3v2 tag


read

public static TagContent read(boolean encoding,
                              ID3v2 id3v2,
                              java.lang.String type)
                       throws FrameDamagedException
Read content from ID3v2 tag.

Parameters:
encoding - Use encoding?
id3v2 - ID3v2 tag to read from
type - Type of frame to read
Returns:
Content of tag
Throws:
FrameDamagedException - If frame is damaged (e.g. too short)