org.jaudiotagger.tag.id3
Class AbstractID3v2Frame

java.lang.Object
  extended by org.jaudiotagger.tag.id3.AbstractTagItem
      extended by org.jaudiotagger.tag.id3.AbstractTagFrame
          extended by org.jaudiotagger.tag.id3.AbstractID3v2Frame
All Implemented Interfaces:
TagField
Direct Known Subclasses:
ID3v22Frame, ID3v23Frame, ID3v24Frame

public abstract class AbstractID3v2Frame
extends AbstractTagFrame
implements TagField

This abstract class is each frame header inside a ID3v2 tag.

Version:
$Id: AbstractID3v2Frame.java,v 1.24 2007/11/26 14:20:28 paultaylor Exp $
Author:
: Paul Taylor, : Eric Farng

Field Summary
 
Fields inherited from class org.jaudiotagger.tag.id3.AbstractTagItem
logger
 
Constructor Summary
AbstractID3v2Frame(AbstractID3v2Frame frame)
          Create a frame based on another frame
AbstractID3v2Frame(AbstractID3v2FrameBody body)
          Create a frame based on a body
AbstractID3v2Frame(java.lang.String identifier)
          Create a new frame with empty body based on identifier
 
Method Summary
 void copyContent(TagField field)
          This method copies the data of the given field to the current data.
 void createStructure()
          Return String Representation of frame
 java.lang.String getId()
          Return the frame identifier, this only identifiies the frame it does not provide a unique key, when using frames such as TXXX which are used by many fields *
 java.lang.String getIdentifier()
          Return the frame identifier
 byte[] getRawContent()
          This method delivers the binary representation of the fields data in order to be directly written to the file.
 void isBinary(boolean b)
          This method will set the field to represent binary data.
Some implementations may support conversions.
As of now (Octobre 2005) there is no implementation really using this method to perform useful operations.
 boolean isEmpty()
          Determines whether the content of the field is empty.
abstract  void write(java.io.ByteArrayOutputStream tagBuffer)
           
 
Methods inherited from class org.jaudiotagger.tag.id3.AbstractTagFrame
equals, getBody, isSubsetOf, setBody
 
Methods inherited from class org.jaudiotagger.tag.id3.AbstractTagItem
getSize, read
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jaudiotagger.tag.TagField
isBinary, isCommon, toString
 

Constructor Detail

AbstractID3v2Frame

public AbstractID3v2Frame(AbstractID3v2Frame frame)
Create a frame based on another frame


AbstractID3v2Frame

public AbstractID3v2Frame(AbstractID3v2FrameBody body)
Create a frame based on a body


AbstractID3v2Frame

public AbstractID3v2Frame(java.lang.String identifier)
Create a new frame with empty body based on identifier

Method Detail

getId

public java.lang.String getId()
Return the frame identifier, this only identifiies the frame it does not provide a unique key, when using frames such as TXXX which are used by many fields *

Specified by:
getId in interface TagField
Returns:
the frame identifier (Tag Field Interface)

getIdentifier

public java.lang.String getIdentifier()
Return the frame identifier

Specified by:
getIdentifier in class AbstractTagItem
Returns:
the frame identifier

copyContent

public void copyContent(TagField field)
Description copied from interface: TagField
This method copies the data of the given field to the current data.

Specified by:
copyContent in interface TagField
Parameters:
field - The field containing the data to be taken.

getRawContent

public byte[] getRawContent()
Description copied from interface: TagField
This method delivers the binary representation of the fields data in order to be directly written to the file.

Specified by:
getRawContent in interface TagField
Returns:
Binary data representing the current tag field.

write

public abstract void write(java.io.ByteArrayOutputStream tagBuffer)

isBinary

public void isBinary(boolean b)
Description copied from interface: TagField
This method will set the field to represent binary data.
Some implementations may support conversions.
As of now (Octobre 2005) there is no implementation really using this method to perform useful operations.

Specified by:
isBinary in interface TagField
Parameters:
b -

isEmpty

public boolean isEmpty()
Description copied from interface: TagField
Determines whether the content of the field is empty.

Specified by:
isEmpty in interface TagField
Returns:
true if no data is stored (or empty String).

createStructure

public void createStructure()
Return String Representation of frame