|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jaudiotagger.tag.id3.AbstractTagItem
org.jaudiotagger.tag.id3.AbstractTagFrameBody
org.jaudiotagger.tag.id3.framebody.AbstractID3v2FrameBody
org.jaudiotagger.tag.id3.framebody.AbstractFrameBodyTextInfo
public abstract class AbstractFrameBodyTextInfo
Abstract representation of a Text Frame
The text information frames are often the most important frames, containing information like artist, album and more. There may only be one text information frame of its kind in an tag. In ID3v24 All text information frames supports multiple strings, stored as a null separated list, where null is represented by the termination code for the character encoding. All text frame identifiers begin with "T". Only text frame identifiers begin with "T", with the exception of the "TXXX" frame. All the text information frames have the following format:getFirstTextValue()
Field Summary |
---|
Fields inherited from class org.jaudiotagger.tag.id3.framebody.AbstractID3v2FrameBody |
---|
TYPE_BODY |
Fields inherited from class org.jaudiotagger.tag.id3.AbstractTagFrameBody |
---|
objectList |
Fields inherited from class org.jaudiotagger.tag.id3.AbstractTagItem |
---|
logger |
Constructor Summary | |
---|---|
protected |
AbstractFrameBodyTextInfo()
Creates a new FrameBodyTextInformation datatype. |
protected |
AbstractFrameBodyTextInfo(AbstractFrameBodyTextInfo body)
Copy Constructor |
protected |
AbstractFrameBodyTextInfo(java.nio.ByteBuffer byteBuffer,
int frameSize)
Creates a new FrameBodyTextInformation data type from file. |
protected |
AbstractFrameBodyTextInfo(byte textEncoding,
java.lang.String text)
Creates a new FrameBodyTextInformation data type. |
Method Summary | |
---|---|
void |
addTextValue(java.lang.String value)
Add additional value to value |
java.lang.String |
getFirstTextValue()
Get first value |
int |
getNumberOfValues()
|
java.lang.String |
getText()
Retrieve the complete text String as it is held internally. |
java.lang.String |
getTextWithoutTrailingNulls()
Retrieve the complete text String but without any trailing nulls If multiple values are held these will be returned, needless trailing nulls will not be returned |
java.lang.String |
getUserFriendlyValue()
|
java.lang.String |
getValueAtIndex(int index)
Get text value at index When a multiple values are stored within a single text frame this method allows access to any of the individual values. |
void |
setText(java.lang.String text)
Set the Full Text String. |
protected void |
setupObjectList()
Setup the Object List. |
void |
write(java.io.ByteArrayOutputStream tagBuffer)
Because Text frames have a text encoding we need to check the text String does not contain characters that cannot be encoded in current encoding before we write data. |
Methods inherited from class org.jaudiotagger.tag.id3.framebody.AbstractID3v2FrameBody |
---|
createStructure, equals, getIdentifier, getSize, read, setSize, setSize |
Methods inherited from class org.jaudiotagger.tag.id3.AbstractTagFrameBody |
---|
getBriefDescription, getHeader, getLongDescription, getObject, getObjectValue, getTextEncoding, isSubsetOf, iterator, setHeader, setObjectValue, setTextEncoding, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
protected AbstractFrameBodyTextInfo()
protected AbstractFrameBodyTextInfo(AbstractFrameBodyTextInfo body)
body
- AbstractFrameBodyTextInformationprotected AbstractFrameBodyTextInfo(byte textEncoding, java.lang.String text)
textEncoding
- Specifies what encoding should be used to write
text to file.text
- Specifies the text String.protected AbstractFrameBodyTextInfo(java.nio.ByteBuffer byteBuffer, int frameSize) throws InvalidTagException
The super.super Constructor sets up the Object list for the frame.
byteBuffer
- frameSize
-
InvalidTagException
- if unable to create framebody from bufferMethod Detail |
---|
public void setText(java.lang.String text)
If this String contains null terminator characters these are parsed as value separators, allowing you to hold multiple strings within one text frame. This functionality is only officially support in ID3v24.
text
- to setpublic java.lang.String getUserFriendlyValue()
getUserFriendlyValue
in class AbstractTagFrameBody
public java.lang.String getText()
public java.lang.String getTextWithoutTrailingNulls()
public java.lang.String getFirstTextValue()
public java.lang.String getValueAtIndex(int index)
index
-
public void addTextValue(java.lang.String value)
value
- at indexpublic int getNumberOfValues()
public void write(java.io.ByteArrayOutputStream tagBuffer)
write
in class AbstractID3v2FrameBody
protected void setupObjectList()
setupObjectList
in class AbstractTagFrameBody
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |