org.blinkenlights.jid3.v2
Class RBUFID3V2Frame

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

public class RBUFID3V2Frame
extends ID3V2Frame

Frame containing recommended buffer size information.


Constructor Summary
RBUFID3V2Frame(java.io.InputStream oIS)
           
RBUFID3V2Frame(int i24BufferSize, boolean bEmbeddedInfoFlag)
          Creates a new instance of RBUFID3V2Frame.
RBUFID3V2Frame(int i24BufferSize, boolean bEmbeddedInfoFlag, int iOffsetToNextTag)
          Creates a new instance of RBUFID3V2Frame.
 
Method Summary
 void accept(ID3Visitor oID3Visitor)
          Accept a visitor.
 boolean equals(java.lang.Object oOther)
           
 int getBufferSize()
          Get recommended buffer size.
 boolean getEmbeddedInfoFlag()
          Get the embedded info flag.
protected  byte[] getFrameId()
          Get the four bytes which uniquely specify of which type this frame is.
 int getOffsetToNextTag()
          Get the offset to the next tag.
 void setRecommendedBufferSize(int i24BufferSize, boolean bEmbeddedInfoFlag)
          Set the recommended buffer size.
 void setRecommendedBufferSize(int i24BufferSize, boolean bEmbeddedInfoFlag, int iOffsetToNextTag)
          Set the recommended buffer size.
 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

RBUFID3V2Frame

public RBUFID3V2Frame(int i24BufferSize,
                      boolean bEmbeddedInfoFlag,
                      int iOffsetToNextTag)
               throws ID3Exception
Creates a new instance of RBUFID3V2Frame.

Parameters:
i24BufferSize - the recommended buffer size, as a 24-bit unsigned value
bEmbeddedInfoFlag - an indicator whether or not a frame the of the specified maximum size may occur in the audiostream
iOffsetToNextTag - the distance from the end of this tag to the start of the next
Throws:
ID3Exception - if i24BufferSize contains an overflow value, or if iOffsetToNextTag is negative

RBUFID3V2Frame

public RBUFID3V2Frame(int i24BufferSize,
                      boolean bEmbeddedInfoFlag)
               throws ID3Exception
Creates a new instance of RBUFID3V2Frame. (Omitting an offset value.)

Parameters:
i24BufferSize - the recommended buffer size, as a 24-bit unsigned value
bEmbeddedInfoFlag - an indicator whether or not a frame the of the specified maximum size may occur in the audiostream
Throws:
ID3Exception - if i24BufferSize contains an overflow value, or if iOffsetToNextTag is negative

RBUFID3V2Frame

public RBUFID3V2Frame(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

setRecommendedBufferSize

public void setRecommendedBufferSize(int i24BufferSize,
                                     boolean bEmbeddedInfoFlag,
                                     int iOffsetToNextTag)
                              throws ID3Exception
Set the recommended buffer size.

Parameters:
i24BufferSize - the recommended buffer size, as a 24-bit unsigned value
bEmbeddedInfoFlag - an indicator whether or not a frame the of the specified maximum size may occur in the audiostream
iOffsetToNextTag - the distance from the end of this tag to the start of the next
Throws:
ID3Exception - if i24BufferSize contains an overflow value, or if iOffsetToNextTag is negative

setRecommendedBufferSize

public void setRecommendedBufferSize(int i24BufferSize,
                                     boolean bEmbeddedInfoFlag)
                              throws ID3Exception
Set the recommended buffer size. (Omitting an offset value.)

Parameters:
i24BufferSize - the recommended buffer size, as a 24-bit unsigned value
bEmbeddedInfoFlag - an indicator whether or not a frame the of the specified maximum size may occur in the audiostream
Throws:
ID3Exception - if i24BufferSize contains an overflow value, or if iOffsetToNextTag is negative

getBufferSize

public int getBufferSize()
Get recommended buffer size.

Returns:
the recommended buffer size

getEmbeddedInfoFlag

public boolean getEmbeddedInfoFlag()
Get the embedded info flag.

Returns:
the embedded info flag

getOffsetToNextTag

public int getOffsetToNextTag()
Get the offset to the next tag.

Returns:
the offset to the next tag, or -1 if not specified

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)