org.jaudiotagger.tag.id3.framebody
Class FrameBodyTCMP

java.lang.Object
  org.jaudiotagger.tag.id3.AbstractTagItem
      org.jaudiotagger.tag.id3.AbstractTagFrameBody
          org.jaudiotagger.tag.id3.framebody.AbstractID3v2FrameBody
              org.jaudiotagger.tag.id3.framebody.AbstractFrameBodyTextInfo
                  org.jaudiotagger.tag.id3.framebody.FrameBodyTCMP

All Implemented Interfaces:

ID3v23FrameBody, ID3v24FrameBody

public class FrameBodyTCMP
extends AbstractFrameBodyTextInfo
implements ID3v24FrameBody, ID3v23FrameBody

Is part of a Compilation (iTunes frame)

determines whether or not track is part of compilation

Author:

: Paul Taylor

Field Summary

(package private) static java.lang.String

IS_COMPILATION

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

FrameBodyTCMP()
Creates a new FrameBodyTCMP datatype, with compilation enabled

This is the preferred constructor to use because TCMP frames should not exist unless they are set to true

FrameBodyTCMP(java.nio.ByteBuffer byteBuffer, int frameSize)
Creates a new FrameBodyTIT1 datatype.

FrameBodyTCMP(byte textEncoding, java.lang.String text)
Creates a new FrameBodyTCMP datatype.

FrameBodyTCMP(FrameBodyTCMP body)

Method Summary

java.lang.String	getIdentifier() The ID3v2 frame identifier
boolean	isCompilation()

Methods inherited from class org.jaudiotagger.tag.id3.framebody.AbstractFrameBodyTextInfo

addTextValue, getFirstTextValue, getNumberOfValues, getText, getValueAtIndex, setText, setupObjectList, write

Methods inherited from class org.jaudiotagger.tag.id3.framebody.AbstractID3v2FrameBody

createStructure, equals, 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

Field Detail

IS_COMPILATION

static java.lang.String IS_COMPILATION

Constructor Detail

FrameBodyTCMP

public FrameBodyTCMP()

Creates a new FrameBodyTCMP datatype, with compilation enabled

This is the preferred constructor to use because TCMP frames should not exist unless they are set to true

FrameBodyTCMP

public FrameBodyTCMP(FrameBodyTCMP body)

FrameBodyTCMP

public FrameBodyTCMP(byte textEncoding,
                     java.lang.String text)

Creates a new FrameBodyTCMP datatype.

Parameters:

textEncoding -

text -

FrameBodyTCMP

public FrameBodyTCMP(java.nio.ByteBuffer byteBuffer,
                     int frameSize)
              throws InvalidTagException

Creates a new FrameBodyTIT1 datatype.

Parameters:

byteBuffer -

frameSize -

Throws:

InvalidTagException

Method Detail

isCompilation

public boolean isCompilation()

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