org.blinkenlights.jid3.v2
Class OWNEID3V2Frame

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

public class OWNEID3V2Frame
extends ID3V2Frame

Frame containing ownership information.


Constructor Summary
OWNEID3V2Frame(java.io.InputStream oIS)
           
OWNEID3V2Frame(java.lang.String sPricePaid, java.lang.String sDateOfPurchase, java.lang.String sSeller)
          Creates a new instance of OWNEID3V2Frame
 
Method Summary
 void accept(ID3Visitor oID3Visitor)
          Accept a visitor.
 boolean equals(java.lang.Object oOther)
           
 java.lang.String getDateOfPurchase()
          Get the date of purchase.
protected  byte[] getFrameId()
          Get the four bytes which uniquely specify of which type this frame is.
 java.lang.String getPricePaid()
          Get price paid.
 java.lang.String getSeller()
          Get the name of the seller.
 TextEncoding getTextEncoding()
          Get the text encoding used for the seller in this frame.
 void setOwnershipInformation(java.lang.String sPricePaid, java.lang.String sDateOfPurchase, java.lang.String sSeller)
          Set ownership information.
 void setTextEncoding(TextEncoding oTextEncoding)
          Set the text encoding to be used for the seller 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

OWNEID3V2Frame

public OWNEID3V2Frame(java.lang.String sPricePaid,
                      java.lang.String sDateOfPurchase,
                      java.lang.String sSeller)
               throws ID3Exception
Creates a new instance of OWNEID3V2Frame

Parameters:
sPricePaid - a price(s) string (a price string consists of a three letter ISO-4217 currency code, followed by an amount, where "." is used as the decimal separator). Multiple prices may be separated by a "/" characters
sDateOfPurchase - the date of the purchase, in the format YYYYMMDD
sSeller - the name of the seller of this file
Throws:
ID3Exception - if sPricePaid is null or not in a valid format, if sDateOfPurchase is null or not in the correct format, or if sSeller is null

OWNEID3V2Frame

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

setOwnershipInformation

public void setOwnershipInformation(java.lang.String sPricePaid,
                                    java.lang.String sDateOfPurchase,
                                    java.lang.String sSeller)
                             throws ID3Exception
Set ownership information.

Parameters:
sPricePaid - a price(s) string (a price string consists of a three letter ISO-4217 currency code, followed by an amount, where "." is used as the decimal separator). Multiple prices may be separated by a "/" characters
sDateOfPurchase - the date of the purchase, in the format YYYYMMDD
sSeller - the name of the seller of this file
Throws:
ID3Exception - if sPricePaid is null or not in a valid format, if sDateOfPurchase is null or not in the correct format, or if sSeller is null

getPricePaid

public java.lang.String getPricePaid()
Get price paid.

Returns:
the price paid

getDateOfPurchase

public java.lang.String getDateOfPurchase()
Get the date of purchase.

Returns:
the date of purchase

getSeller

public java.lang.String getSeller()
Get the name of the seller.

Returns:
the name of the seller

setTextEncoding

public void setTextEncoding(TextEncoding oTextEncoding)
Set the text encoding to be used for the seller 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 seller 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)