org.digitalmediaserver.cuelib.id3

Class TextFrame

java.lang.Object

org.digitalmediaserver.cuelib.id3.TextFrame

All Implemented Interfaces:

ID3Frame

public class TextFrame
extends Object
implements ID3Frame

The Class TextFrame.

Field Summary

Fields inherited from interface org.digitalmediaserver.cuelib.id3.ID3Frame

COMPRESSION_USED, DATA_LENGTH_INDICATOR, ENCRYPTION_METHOD_USED, GROUP_ID, PRESERVE_FRAME_WHEN_FILE_ALTERED, PRESERVE_FRAME_WHEN_TAG_ALTERED, READ_ONLY, UNSYNC_USED

Constructor Summary

Constructors

Constructor and Description
TextFrame(CanonicalFrameType canonicalFrameType) Instantiates a new text frame.
TextFrame(CanonicalFrameType canonicalFrameType, String text) Instantiates a new text frame.
TextFrame(CanonicalFrameType canonicalFrameType, String text, int totalFrameSize) Instantiates a new text frame.

Method Summary

Modifier and Type	Method and Description
String	getAdditionalTypeInfo() Get the additionalTypeInfo of this TextFrame.
CanonicalFrameType	getCanonicalFrameType() Gets the canonical frame type.
Charset	getCharset()
Properties	getFlags()
String	getText()
int	getTotalFrameSize() Gets the total frame size.
void	setAdditionalTypeInfo(String additionalTypeInfo) Set the additionalTypeInfo of this TextFrame.
void	setCanonicalFrameType(CanonicalFrameType canonicalFrameType) Sets the canonical frame type.
void	setCharset(Charset charset) Set the Charset.
void	setText(String text)
void	setTotalFrameSize(int totalFrameSize)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TextFrame

public TextFrame(CanonicalFrameType canonicalFrameType)

Instantiates a new text frame.

Parameters:

canonicalFrameType - the canonical frame type

TextFrame

public TextFrame(CanonicalFrameType canonicalFrameType,
                 String text)

Instantiates a new text frame.

Parameters:

canonicalFrameType - the canonical frame type

text - the text

TextFrame

public TextFrame(CanonicalFrameType canonicalFrameType,
                 String text,
                 int totalFrameSize)

Instantiates a new text frame.

Parameters:

canonicalFrameType - the canonical frame type

text - the text

totalFrameSize - the total frame size

Method Detail

toString

public String toString()

Overrides:

toString in class Object

setCharset

public void setCharset(Charset charset)

Set the Charset.

Parameters:

charset - the Charset.

getCharset

public Charset getCharset()

Returns:

The Charset.

getTotalFrameSize

public int getTotalFrameSize()

Description copied from interface: ID3Frame

Gets the total frame size.

Specified by:

getTotalFrameSize in interface ID3Frame

Returns:

the declaredSize

setTotalFrameSize

public void setTotalFrameSize(int totalFrameSize)

Parameters:

totalFrameSize - the totalFrameSize to set

getText

public String getText()

Returns:

the text

setText

public void setText(String text)

Parameters:

text - the text to set

getCanonicalFrameType

public CanonicalFrameType getCanonicalFrameType()

Description copied from interface: ID3Frame

Gets the canonical frame type.

Specified by:

getCanonicalFrameType in interface ID3Frame

Returns:

the canonical frame type

setCanonicalFrameType

public void setCanonicalFrameType(CanonicalFrameType canonicalFrameType)

Sets the canonical frame type.

Parameters:

canonicalFrameType - the new canonical frame type

getFlags

public Properties getFlags()

Specified by:

getFlags in interface ID3Frame

Returns:

the flags

getAdditionalTypeInfo

public String getAdditionalTypeInfo()

Get the additionalTypeInfo of this TextFrame.

Returns:

The additionalTypeInfo of this TextFrame.

setAdditionalTypeInfo

public void setAdditionalTypeInfo(String additionalTypeInfo)

Set the additionalTypeInfo of this TextFrame.

Parameters:

additionalTypeInfo - The additionalTypeInfo of this TextFrame.