|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tffenterprises.music.tag.id3v2.Frame
com.tffenterprises.music.tag.id3v2.frame.BaseFrame
com.tffenterprises.music.tag.id3v2.frame.TextBasedFrame
com.tffenterprises.music.tag.id3v2.frame.TXXXFrame
public class TXXXFrame
This class is the ID3v2 TXXX frame type; it handles "user-defined text" frames, which contain two strings (the "Description" and the "Value").
Field Summary | |
---|---|
private static java.lang.String |
FRAME_ID
The frame ID of this frame. |
private java.lang.String |
frameDescription
The description text for this frame. |
private java.lang.String |
frameValue
The value text for this frame. |
Fields inherited from class com.tffenterprises.music.tag.id3v2.frame.TextBasedFrame |
---|
BOM_CHAR, BOM_CHAR_STRING, ENCODING_STRINGS, ISO_8859_1, NULL_BOM_STRING, NULL_CHAR, NULL_CHAR_STRING, UNICODE, UNICODE_BIG, UNICODE_LITTLE, UTF8 |
Constructor Summary | |
---|---|
TXXXFrame()
Constructs a new TXXXFrame with no description or value. |
|
TXXXFrame(FrameHeader header)
Constructs a TXXXFrame using the given header. |
|
TXXXFrame(FrameHeader header,
java.lang.String frameDescription,
java.lang.String frameValue)
Constructs a new TXXXFrame with the specified header, description and value. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Returns a clone of this ID3v2 frame. |
boolean |
equals(java.lang.Object other)
Compares this ID3v2 frame with another object. |
java.lang.String |
getDescription()
Returns the description field of this frame. |
byte[] |
getRawData()
Returns the raw data corresponding to this frame. |
java.lang.String |
getValue()
Returns the value field of this frame. |
boolean |
isOfRepeatableType()
Reveals whether it is legal for multiple frames of this type to exist in the same ID3v2 tag. |
void |
setDescription(java.lang.String frameDescription)
Sets the description field of this frame. |
void |
setRawData(byte[] rawData)
Sets the raw data corresponding to this frame. |
void |
setValue(java.lang.String frameValue)
Sets the value field of this frame. |
java.lang.String |
toString()
Returns a String representation of this frame. |
Methods inherited from class com.tffenterprises.music.tag.id3v2.frame.TextBasedFrame |
---|
getNullBytes, getTextEncoding, getTextEncoding, getTextEncoding, is8859String, read8859Characters, read8859String, readCharacters, readString, readUnicodeCharacters, readUnicodeString |
Methods inherited from class com.tffenterprises.music.tag.id3v2.frame.BaseFrame |
---|
getBytes, getChecksum, getFormatFlags, getFrameID, getHeader, getStatusFlags, hashCode, isChanged, setChanged, setFormatFlags, setStatusFlags, toByteArray, updateChecksum, writeTo |
Methods inherited from class com.tffenterprises.music.tag.id3v2.Frame |
---|
FromByteArray, FromByteArray, FromInputStream, GetFrameClassForID, getNewInstance, getNewInstance, getNewInstance, MinimumLength, RegisterFrameClass, UnregisterFrameClass |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private static final java.lang.String FRAME_ID
private java.lang.String frameDescription
private java.lang.String frameValue
Constructor Detail |
---|
public TXXXFrame()
public TXXXFrame(FrameHeader header) throws java.lang.IllegalArgumentException
header
- The FrameHeader to be used for this Frame instance.
See FrameHeader
for details.
java.lang.IllegalArgumentException
- This is exception is thrown when
the parameter is unacceptable for
use with an object of this
Frame class/subclass.public TXXXFrame(FrameHeader header, java.lang.String frameDescription, java.lang.String frameValue) throws java.lang.IllegalArgumentException
header
- The FrameHeader to be used for this Frame instanceframeDescription
- The frame descriptionframeValue
- The frame value
java.lang.IllegalArgumentException
- if the specified frame type,
the specified frame description,
or the specified frame value is null.Method Detail |
---|
public java.lang.Object clone()
clone
in class BaseFrame
public boolean equals(java.lang.Object other)
equals
in class BaseFrame
other
- The other object.
public java.lang.String toString()
toString
in class BaseFrame
public byte[] getRawData()
getRawData
in class BaseFrame
public void setRawData(byte[] rawData) throws FrameDataFormatException, java.lang.IllegalArgumentException
setRawData
in class BaseFrame
rawData
- The raw data.
FrameDataFormatException
- if the raw data is not in an
appropriate format for this
frame's type.
java.lang.IllegalArgumentException
- if the specified raw data is null.public boolean isOfRepeatableType()
true
.
isOfRepeatableType
in interface KeyedFrame
isOfRepeatableType
in class BaseFrame
public java.lang.String getDescription()
getDescription
in interface KeyedFrame
public void setDescription(java.lang.String frameDescription)
frameDescription
- The description text.
java.lang.IllegalArgumentException
- if the description text is null.public java.lang.String getValue()
public void setValue(java.lang.String frameValue)
frameValue
- The value text.
java.lang.IllegalArgumentException
- if the value text is null.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |