org.jaudiotagger.tag.id3.framebody
Class FrameBodyUSER

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

All Implemented Interfaces:

ID3v23FrameBody, ID3v24FrameBody

public class FrameBodyUSER
extends AbstractID3v2FrameBody
implements ID3v24FrameBody, ID3v23FrameBody

Terms of use frame.

This frame contains a brief description of the terms of use and ownership of the file. More detailed information concerning the legal terms might be available through the "WCOP" frame. Newlines are allowed in the text. There may only be one "USER" frame in a tag.

<Header for 'Terms of use frame', ID: "USER">
Text encoding	$xx
Language	$xx xx xx
The actual text	<text string according to encoding>

For more details, please refer to the ID3 specifications:

• ID3 v2.3.0 Spec

Version:

$Id: FrameBodyUSER.java,v 1.19 2009/11/12 15:42:57 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

FrameBodyUSER()
Creates a new FrameBodyUSER datatype.

FrameBodyUSER(java.nio.ByteBuffer byteBuffer, int frameSize)
Create a new FrameBodyUser by reading from byte buffer

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

FrameBodyUSER(FrameBodyUSER body)

Method Summary

java.lang.String	getIdentifier() The ID3v2 frame identifier
java.lang.String	getLanguage()
void	setOwner(java.lang.String language)
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
void	write(java.io.ByteArrayOutputStream tagBuffer) If the text cannot be encoded using current encoder, change the encoder

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

Constructor Detail

FrameBodyUSER

public FrameBodyUSER()

Creates a new FrameBodyUSER datatype.

FrameBodyUSER

public FrameBodyUSER(FrameBodyUSER body)

FrameBodyUSER

public FrameBodyUSER(byte textEncoding,
                     java.lang.String language,
                     java.lang.String text)

Creates a new FrameBodyUSER datatype.

Parameters:

textEncoding -

language -

text -

FrameBodyUSER

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

Create a new FrameBodyUser by reading from byte buffer

Parameters:

byteBuffer -

frameSize -

Throws:

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

getLanguage

public java.lang.String getLanguage()

Returns:

lanaguage

setOwner

public void setOwner(java.lang.String language)

Parameters:

language -

write

public void write(java.io.ByteArrayOutputStream tagBuffer)

If the text cannot be encoded using current encoder, change the encoder

Overrides:

write in class AbstractID3v2FrameBody

Parameters:

tagBuffer -

Throws:

java.io.IOException

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