org.blinkenlights.jid3.v2
Class WXXXUrlLinkID3V2Frame

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

public class WXXXUrlLinkID3V2Frame
extends UrlLinkID3V2Frame


Field Summary
 
Fields inherited from class org.blinkenlights.jid3.v2.UrlLinkID3V2Frame
m_sURL
 
Constructor Summary
WXXXUrlLinkID3V2Frame(java.io.InputStream oIS)
           
WXXXUrlLinkID3V2Frame(java.lang.String sDescription, java.lang.String sUrl)
          Constructor.
WXXXUrlLinkID3V2Frame(java.lang.String sDescription, java.net.URL oURL)
          Constructor.
 
Method Summary
 void accept(ID3Visitor oID3Visitor)
          Accept a visitor.
 boolean equals(java.lang.Object oOther)
           
 java.lang.String getDescription()
          Get the description of the URL stored in this frame.
protected  byte[] getFrameId()
          Get the four bytes which uniquely specify of which type this frame is.
 TextEncoding getTextEncoding()
          Get the text encoding used for the description in this frame.
 java.lang.String getUrl()
          Get the URL stored in this frame.
 void setDescriptionAndUrl(java.lang.String sDescription, java.lang.String sUrl)
          Set the description of the URL to be stored in this frame, along with the actual URL.
 void setDescriptionAndUrl(java.lang.String sDescription, java.net.URL oURL)
          Set the description of the URL to be stored in this frame, along with the actual URL.
 void setTextEncoding(TextEncoding oTextEncoding)
          Set the text encoding to be used for the 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 this frame to an 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

WXXXUrlLinkID3V2Frame

public WXXXUrlLinkID3V2Frame(java.lang.String sDescription,
                             java.lang.String sUrl)
                      throws ID3Exception
Constructor.

Parameters:
sDescription - a description of the URL being stored
sUrl - the URL being stored
Throws:
ID3Exception - if the URL passed is null, or if the description is null

WXXXUrlLinkID3V2Frame

public WXXXUrlLinkID3V2Frame(java.lang.String sDescription,
                             java.net.URL oURL)
                      throws ID3Exception
Constructor.

Parameters:
sDescription - a description of the URL being stored
oURL - the URL being stored
Throws:
ID3Exception - if the URL passed is null, or if the description is null

WXXXUrlLinkID3V2Frame

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

setDescriptionAndUrl

public void setDescriptionAndUrl(java.lang.String sDescription,
                                 java.lang.String sUrl)
                          throws ID3Exception
Set the description of the URL to be stored in this frame, along with the actual URL.

Parameters:
sDescription - a description of the URL being stored
sUrl - the URL being stored
Throws:
ID3Exception - if the URL passed is null, or if the description is null

setDescriptionAndUrl

public void setDescriptionAndUrl(java.lang.String sDescription,
                                 java.net.URL oURL)
                          throws ID3Exception
Set the description of the URL to be stored in this frame, along with the actual URL.

Parameters:
sDescription - a description of the URL being stored
oURL - the URL being stored
Throws:
ID3Exception - if the URL passed is null, or if the description is null

getDescription

public java.lang.String getDescription()
Get the description of the URL stored in this frame.

Returns:
the description of the URL stored in this frame

getUrl

public java.lang.String getUrl()
Get the URL stored in this frame.

Returns:
the URL stored in this frame (note returned value may not be a valid url)

setTextEncoding

public void setTextEncoding(TextEncoding oTextEncoding)
Set the text encoding to be used for the 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 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: UrlLinkID3V2Frame
Write the body of this frame to an output stream.

Overrides:
writeBody in class UrlLinkID3V2Frame
Parameters:
oIDOS - the ID3 output stream to which the frame body is to be written
Throws:
java.io.IOException

equals

public boolean equals(java.lang.Object oOther)