org.blinkenlights.jid3.v2
Class GEOBID3V2Frame

java.lang.Object
  extended byorg.blinkenlights.jid3.v2.ID3V2Frame
      extended byorg.blinkenlights.jid3.v2.GEOBID3V2Frame
All Implemented Interfaces:
ID3Subject, ID3Visitable

public class GEOBID3V2Frame
extends ID3V2Frame


Constructor Summary
GEOBID3V2Frame(java.io.InputStream oIS)
           
GEOBID3V2Frame(java.lang.String sMimeType, java.lang.String sFilename, java.lang.String sContentDescription, byte[] abyEncapsulatedObjectData)
          Constructor.
 
Method Summary
 void accept(ID3Visitor oID3Visitor)
          Accept a visitor.
 boolean equals(java.lang.Object oOther)
           
 java.lang.String getContentDescription()
          Get the content description of the object in this frame.
 byte[] getEncapsulatedObjectData()
          Get the encapsulated object data in this frame.
 java.lang.String getFilename()
          Get the filename of the object in this frame.
protected  byte[] getFrameId()
          Get the four bytes which uniquely specify of which type this frame is.
 java.lang.String getMimeType()
          Get the mime type of the object in this frame.
 TextEncoding getTextEncoding()
          Get the text encoding used for the filename and content description in this frame.
 void setEncapsulatedObject(java.lang.String sMimeType, java.lang.String sFilename, java.lang.String sContentDescription, byte[] abyEncapsulatedObjectData)
          Set the encapsulated object for this frame.
 void setTextEncoding(TextEncoding oTextEncoding)
          Set the text encoding to be used for the filename and content description in this frame.
 java.lang.String toString()
          Represent the contents of this frame as a string.
protected  void writeBody(ID3DataOutputStream oIDOS)
          Write the body of the frame to an ID3 data output stream.
 
Methods inherited from class org.blinkenlights.jid3.v2.ID3V2Frame
addID3Observer, getEncryptionMethod, isEncrypted, notifyID3Observers, removeID3Observer, setCompressionFlag, setEncryption, setFileAlterPreservationFlag, setGroupingIdentityFlag, setReadOnlyFlag, setTagAlterPreservationFlag, write, writeHeader
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GEOBID3V2Frame

public GEOBID3V2Frame(java.lang.String sMimeType,
                      java.lang.String sFilename,
                      java.lang.String sContentDescription,
                      byte[] abyEncapsulatedObjectData)
               throws ID3Exception
Constructor.

Parameters:
sMimeType - the mime type of the file being stored (optional)
sFilename - the filename of the file being stored (optional)
sContentDescription - a brief description of the content (required)
abyEncapsulatedObjectData - the data file being stored in this frame
Throws:
ID3Exception - if the required content description is null or zero length
ID3Exception - if the required object data is null or zero length

GEOBID3V2Frame

public GEOBID3V2Frame(java.io.InputStream oIS)
               throws ID3Exception
Method Detail

accept

public void accept(ID3Visitor oID3Visitor)
Description copied from interface: ID3Visitable
Accept a visitor.

Parameters:
oID3Visitor - a visitor of this object

setEncapsulatedObject

public void setEncapsulatedObject(java.lang.String sMimeType,
                                  java.lang.String sFilename,
                                  java.lang.String sContentDescription,
                                  byte[] abyEncapsulatedObjectData)
                           throws ID3Exception
Set the encapsulated object for this frame.

Parameters:
sMimeType - the mime type of the file being stored (optional)
sFilename - the filename of the file being stored (optional)
sContentDescription - a brief description of the content (required)
abyEncapsulatedObjectData - the data file being stored in this frame
Throws:
ID3Exception - if the required content description is null or zero length
ID3Exception - if the required object data is null or zero length
ID3Exception - if this frame is in a tag with another GEOB frame which would have the same content description

getMimeType

public java.lang.String getMimeType()
Get the mime type of the object in this frame.

Returns:
the mime type, or null if one has been set

getFilename

public java.lang.String getFilename()
Get the filename of the object in this frame.

Returns:
the filename, or null if one has not been set

getContentDescription

public java.lang.String getContentDescription()
Get the content description of the object in this frame.

Returns:
the content description

getEncapsulatedObjectData

public byte[] getEncapsulatedObjectData()
Get the encapsulated object data in this frame.

Returns:
the encapsulated object data

setTextEncoding

public void setTextEncoding(TextEncoding oTextEncoding)
Set the text encoding to be used for the filename and content description in this frame.

Parameters:
oTextEncoding - the text encoding to be used for this frame

getTextEncoding

public TextEncoding getTextEncoding()
Get the text encoding used for the filename and content description in this frame.

Returns:
the text encoding to be used for this frame

getFrameId

protected byte[] getFrameId()
Description copied from class: ID3V2Frame
Get the four bytes which uniquely specify of which type this frame is.

Specified by:
getFrameId in class ID3V2Frame

toString

public java.lang.String toString()
Description copied from class: ID3V2Frame
Represent the contents of this frame as a string. For debugging purposes.

Specified by:
toString in class ID3V2Frame
Returns:
a string representing this frame

writeBody

protected void writeBody(ID3DataOutputStream oIDOS)
                  throws java.io.IOException
Description copied from class: ID3V2Frame
Write the body of the frame to an ID3 data output stream.

Specified by:
writeBody in class ID3V2Frame
Parameters:
oIDOS - the output stream to write to
Throws:
java.io.IOException

equals

public boolean equals(java.lang.Object oOther)