org.jaudiotagger.tag.id3.framebody
Class FrameBodyTRCK

java.lang.Object
  extended by org.jaudiotagger.tag.id3.AbstractTagItem
      extended by org.jaudiotagger.tag.id3.AbstractTagFrameBody
          extended by org.jaudiotagger.tag.id3.framebody.AbstractID3v2FrameBody
              extended by org.jaudiotagger.tag.id3.framebody.FrameBodyTRCK
All Implemented Interfaces:
ID3v23FrameBody, ID3v24FrameBody

public class FrameBodyTRCK
extends AbstractID3v2FrameBody
implements ID3v23FrameBody, ID3v24FrameBody

Track number/position in set Text Information frame.

The 'Track number/Position in set' frame is a numeric string containing the order number of the audio-file on its original recording. This may be extended with a "/" character and a numeric string containing the total number of tracks/elements on the original recording. e.g. "4/9". Some applications like to prepend the track number with a zero to aid sorting, (i.e 02 comes before 10)

For more details, please refer to the ID3 specifications:

Version:
$Id: FrameBodyTRCK.java,v 1.13 2009/11/12 13:25:21 paultaylor Exp $
Author:
: Paul Taylor, : Eric Farng

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
FrameBodyTRCK()
          Creates a new FrameBodyTRCK datatype.
FrameBodyTRCK(java.nio.ByteBuffer byteBuffer, int frameSize)
          Creates a new FrameBodyTRCK datatype.
FrameBodyTRCK(byte textEncoding, java.lang.Integer trackNo, java.lang.Integer trackTotal)
           
FrameBodyTRCK(byte textEncoding, java.lang.String text)
          Creates a new FrameBodyTRCK datatype, the value is parsed literally
FrameBodyTRCK(FrameBodyTRCK body)
           
 
Method Summary
 java.lang.String getIdentifier()
          The ID3v2 frame identifier
 java.lang.String getText()
           
 java.lang.Integer getTrackNo()
           
 java.lang.Integer getTrackTotal()
           
 void setText(java.lang.String text)
           
 void setTrackNo(java.lang.Integer trackNo)
           
 void setTrackNo(java.lang.String trackNo)
           
 void setTrackTotal(java.lang.Integer trackTotal)
           
protected  void setupObjectList()
          Create the list of Datatypes that this body expects in the correct order This method needs to be implemented by concrete subclasses
 
Methods inherited from class org.jaudiotagger.tag.id3.framebody.AbstractID3v2FrameBody
createStructure, equals, getSize, read, setSize, setSize, write
 
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

FrameBodyTRCK

public FrameBodyTRCK()
Creates a new FrameBodyTRCK datatype.


FrameBodyTRCK

public FrameBodyTRCK(FrameBodyTRCK body)

FrameBodyTRCK

public FrameBodyTRCK(byte textEncoding,
                     java.lang.String text)
Creates a new FrameBodyTRCK datatype, the value is parsed literally

Parameters:
textEncoding -
text -

FrameBodyTRCK

public FrameBodyTRCK(byte textEncoding,
                     java.lang.Integer trackNo,
                     java.lang.Integer trackTotal)

FrameBodyTRCK

public FrameBodyTRCK(java.nio.ByteBuffer byteBuffer,
                     int frameSize)
              throws InvalidTagException
Creates a new FrameBodyTRCK datatype.

Parameters:
byteBuffer -
frameSize -
Throws:
java.io.IOException
InvalidTagException
Method Detail

getIdentifier

public java.lang.String getIdentifier()
The ID3v2 frame identifier

Specified by:
getIdentifier in class AbstractID3v2FrameBody
Returns:
the ID3v2 frame identifier for this frame type

getTrackNo

public java.lang.Integer getTrackNo()

getText

public java.lang.String getText()

setTrackNo

public void setTrackNo(java.lang.Integer trackNo)

setTrackNo

public void setTrackNo(java.lang.String trackNo)

getTrackTotal

public java.lang.Integer getTrackTotal()

setTrackTotal

public void setTrackTotal(java.lang.Integer trackTotal)

setText

public void setText(java.lang.String text)

setupObjectList

protected void setupObjectList()
Description copied from class: AbstractTagFrameBody
Create the list of Datatypes that this body expects in the correct order This method needs to be implemented by concrete subclasses

Specified by:
setupObjectList in class AbstractTagFrameBody