org.blinkenlights.jid3.v2
Class IPLSID3V2Frame

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

public class IPLSID3V2Frame
extends ID3V2Frame


Nested Class Summary
static class IPLSID3V2Frame.InvolvedPerson
          Involved persons.
 
Constructor Summary
IPLSID3V2Frame()
          Constructor.
IPLSID3V2Frame(java.io.InputStream oIS)
           
 
Method Summary
 void accept(ID3Visitor oID3Visitor)
          Accept a visitor.
 void addInvolvedPerson(IPLSID3V2Frame.InvolvedPerson oInvolvedPerson)
          Add an involved person to the list.
 boolean equals(java.lang.Object oOther)
           
protected  byte[] getFrameId()
          Get the four bytes which uniquely specify of which type this frame is.
 IPLSID3V2Frame.InvolvedPerson[] getInvolvedPersons(java.lang.String sInvolvement)
          Get all involved persons with a given involvement.
 TextEncoding getTextEncoding()
          Get the text encoding used for the involved people in this frame.
 IPLSID3V2Frame.InvolvedPerson[] removedInvolvedPersons(java.lang.String sInvolvement)
          Removed all persons with a given involvement.
 void setTextEncoding(TextEncoding oTextEncoding)
          Set the text encoding to be used for the involved people 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

IPLSID3V2Frame

public IPLSID3V2Frame()
Constructor.


IPLSID3V2Frame

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

addInvolvedPerson

public void addInvolvedPerson(IPLSID3V2Frame.InvolvedPerson oInvolvedPerson)
Add an involved person to the list.

Parameters:
oInvolvedPerson - the involved person to be added

getInvolvedPersons

public IPLSID3V2Frame.InvolvedPerson[] getInvolvedPersons(java.lang.String sInvolvement)
Get all involved persons with a given involvement.

Parameters:
sInvolvement - the involvement for which a list of involved persons is to be returned
Returns:
an array of matching involved persons

removedInvolvedPersons

public IPLSID3V2Frame.InvolvedPerson[] removedInvolvedPersons(java.lang.String sInvolvement)
Removed all persons with a given involvement.

Parameters:
sInvolvement - the involvement for which all involved persons are to be removed
Returns:
an array of involved persons which previously matched the specified involvement

setTextEncoding

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