org.jaudiotagger.tag.id3.framebody
Class FrameBodyDeprecated

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.FrameBodyDeprecated
All Implemented Interfaces:
ID3v23FrameBody, ID3v24FrameBody

public class FrameBodyDeprecated
extends AbstractID3v2FrameBody
implements ID3v24FrameBody, ID3v23FrameBody

Represents a framebody for a frame identifier that is not defined for the tag version but was valid for a for an earlier tag version. The body consists of an array of bytes representing all the bytes in the body.


Field Summary
private  AbstractID3v2FrameBody originalFrameBody
           
 
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
FrameBodyDeprecated(AbstractID3v2FrameBody frameBody)
          Creates a new FrameBodyDeprecated wrapper around the frameBody
FrameBodyDeprecated(FrameBodyDeprecated copyObject)
          Copy constructor
 
Method Summary
 boolean equals(java.lang.Object obj)
          Are two bodies equal
 java.lang.String getBriefDescription()
          This method calls toString for all it's objects and appends them without any newline characters.
 java.lang.String getIdentifier()
          Return the frame identifier
 AbstractID3v2FrameBody getOriginalFrameBody()
          Return the original framebody that was used to construct the DeprecatedFrameBody
 int getSize()
          Delgate size to size of original framebody, if framebody already exist will take this value from the frame header but it is always recalculated before writing any changes back to disk.
protected  void setupObjectList()
          Setup the Object List.
 java.lang.String toString()
          Because the contents of this frame are an array of bytes and could be large we just return the identifier.
 
Methods inherited from class org.jaudiotagger.tag.id3.framebody.AbstractID3v2FrameBody
createStructure, read, setSize, setSize, write
 
Methods inherited from class org.jaudiotagger.tag.id3.AbstractTagFrameBody
getHeader, getLongDescription, getObject, getObjectValue, getTextEncoding, isSubsetOf, iterator, setHeader, setObjectValue, setTextEncoding
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

originalFrameBody

private AbstractID3v2FrameBody originalFrameBody
Constructor Detail

FrameBodyDeprecated

public FrameBodyDeprecated(AbstractID3v2FrameBody frameBody)
Creates a new FrameBodyDeprecated wrapper around the frameBody

Parameters:
frameBody -

FrameBodyDeprecated

public FrameBodyDeprecated(FrameBodyDeprecated copyObject)
Copy constructor

Parameters:
copyObject - a copy is made of this
Method Detail

getIdentifier

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

Specified by:
getIdentifier in class AbstractID3v2FrameBody
Returns:
the identifier

getSize

public int getSize()
Delgate size to size of original framebody, if framebody already exist will take this value from the frame header but it is always recalculated before writing any changes back to disk.

Overrides:
getSize in class AbstractID3v2FrameBody
Returns:
size in bytes of this frame body

equals

public boolean equals(java.lang.Object obj)
Description copied from class: AbstractID3v2FrameBody
Are two bodies equal

Overrides:
equals in class AbstractID3v2FrameBody
Parameters:
obj -
Returns:
whether obj is equivalent to this object

getOriginalFrameBody

public AbstractID3v2FrameBody getOriginalFrameBody()
Return the original framebody that was used to construct the DeprecatedFrameBody

Returns:
the original frameBody

toString

public java.lang.String toString()
Because the contents of this frame are an array of bytes and could be large we just return the identifier.

Overrides:
toString in class AbstractTagFrameBody
Returns:
a string representation of this frame

setupObjectList

protected void setupObjectList()
Setup the Object List.

This is handled by the wrapped class

Specified by:
setupObjectList in class AbstractTagFrameBody

getBriefDescription

public java.lang.String getBriefDescription()
Description copied from class: AbstractTagFrameBody
This method calls toString for all it's objects and appends them without any newline characters.

Overrides:
getBriefDescription in class AbstractTagFrameBody
Returns:
brief description string