org.blinkenlights.jid3.v2
Class LINKID3V2Frame

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

public class LINKID3V2Frame
extends ID3V2Frame

Frame containing linked frame information.


Constructor Summary
LINKID3V2Frame(byte[] abyFrameIdentifier, java.lang.String sURL, java.lang.String sAdditionalData)
          Constructor
LINKID3V2Frame(java.io.InputStream oIS)
           
 
Method Summary
 void accept(ID3Visitor oID3Visitor)
          Accept a visitor.
 boolean equals(java.lang.Object oOther)
           
 java.lang.String getAdditionalData()
          Get any additional link-related data in this frame.
protected  byte[] getFrameId()
          Get the four bytes which uniquely specify of which type this frame is.
 byte[] getFrameIdentifier()
          Get the frame identifier of the linked frame.
 java.lang.String getLinkUrl()
          Get the URL pointing to the location of the file containing the linked frame.
 void setContents(byte[] abyFrameIdentifier, java.lang.String sURL, java.lang.String sAdditionalData)
          Set the contents of 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

LINKID3V2Frame

public LINKID3V2Frame(byte[] abyFrameIdentifier,
                      java.lang.String sURL,
                      java.lang.String sAdditionalData)
               throws ID3Exception
Constructor

Parameters:
abyFrameIdentifier - the frame identifier of the frame linked to
sURL - a reference to the location of the linked frame
sAdditionalData - any additional data which may be needed to retrieve the linked frame
Throws:
ID3Exception - if a frame identifier of four bytes is not specified, or if the URL is not specified

LINKID3V2Frame

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

setContents

public void setContents(byte[] abyFrameIdentifier,
                        java.lang.String sURL,
                        java.lang.String sAdditionalData)
                 throws ID3Exception
Set the contents of this frame.

Parameters:
abyFrameIdentifier - the frame identifier of the frame linked to
sURL - a reference to the location of the linked frame
sAdditionalData - any additional data which may be needed to retrieve the linked frame
Throws:
ID3Exception - if a frame identifier of four bytes is not specified, or if the URL is not specified
ID3Exception - if this frame is in a tag with another LINK frame which would have the same contents

getFrameIdentifier

public byte[] getFrameIdentifier()
Get the frame identifier of the linked frame.

Returns:
the frame identifier bytes (which should be of length four)

getLinkUrl

public java.lang.String getLinkUrl()
Get the URL pointing to the location of the file containing the linked frame.

Returns:
the location url

getAdditionalData

public java.lang.String getAdditionalData()
Get any additional link-related data in this frame.

Returns:
any additional link-related data

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)