org.blinkenlights.jid3.v2
Class GRIDID3V2Frame

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

public class GRIDID3V2Frame
extends ID3V2Frame


Constructor Summary
GRIDID3V2Frame(java.io.InputStream oIS)
           
GRIDID3V2Frame(java.lang.String sOwnerIdentifier, byte byGroupSymbol, byte[] abyGroupDependantData)
          Constructor.
 
Method Summary
 void accept(ID3Visitor oID3Visitor)
          Accept a visitor.
 boolean equals(java.lang.Object oOther)
           
protected  byte[] getFrameId()
          Get the four bytes which uniquely specify of which type this frame is.
 byte[] getGroupDependantData()
          Get group dependant data.
 byte getGroupSymbol()
          Get the group symbol for this grouping.
 java.lang.String getOwnerIdentifier()
          Get owner identifier information.
 void setGroupIdentificationRegistration(java.lang.String sOwnerIdentifier, byte byGroupSymbol, byte[] abyGroupDependantData)
          Set group identification registration data.
 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

GRIDID3V2Frame

public GRIDID3V2Frame(java.lang.String sOwnerIdentifier,
                      byte byGroupSymbol,
                      byte[] abyGroupDependantData)
               throws ID3Exception
Constructor.

Parameters:
sOwnerIdentifier - an URL or email address where information about this grouping can be found
byGroupSymbol - a symbol which will be used to identify this group throughout this tag (values lower than $80 are reserved)
abyGroupDependantData - any data which is required for the correct interpretation of this grouping
Throws:
ID3Exception - if the owner identifier is null or zero-length

GRIDID3V2Frame

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

setGroupIdentificationRegistration

public void setGroupIdentificationRegistration(java.lang.String sOwnerIdentifier,
                                               byte byGroupSymbol,
                                               byte[] abyGroupDependantData)
                                        throws ID3Exception
Set group identification registration data.

Parameters:
sOwnerIdentifier - an URL or email address where information about this grouping can be found
byGroupSymbol - a symbol which will be used to identify this group throughout this tag (values lower than $80 are reserved)
abyGroupDependantData - any data which is required for the correct interpretation of this grouping
Throws:
ID3Exception - if the owner identifier is null or zero-length
ID3Exception - if this frame is in a tag with another GRID frame which would have the same group symbol

getOwnerIdentifier

public java.lang.String getOwnerIdentifier()
Get owner identifier information.

Returns:
the owner identifier value, which should be either an URL or an email address

getGroupSymbol

public byte getGroupSymbol()
Get the group symbol for this grouping.

Returns:
the byte value used as a symbol for this group

getGroupDependantData

public byte[] getGroupDependantData()
Get group dependant data.

Returns:
any additional group dependant data, or null if none has been set

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)