pgbennett.id3
Class ID3v2Frames

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.HashMap
          pgbennett.id3.ID3v2Frames

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map

public class ID3v2Frames
extends java.util.HashMap

This class is a collection that is used to hold the ID3v2Frames.

Version History

1.3.1 - 2002.1021 by gruni

-Made Sourcecode compliant to the Sun CodingConventions

1.3 - 2002.0113 by helliker

-Ignore empty frames when calculating length and getting bytes to save space.

1.2 - 2001.1019 by helliker

-All set for release.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

static java.lang.String	ACCOMPANIMENT Description of the Field
static java.lang.String	ALBUM Description of the Field
static java.lang.String	ALBUM_SORT_ORDER Description of the Field
static java.lang.String	ATTACHED_PICTURE Description of the Field
static java.lang.String	AUDIO_ENCRYPTION Description of the Field
static java.lang.String	AUDIO_SEEK_POINT_INDEX Description of the Field
static java.lang.String	BPM Description of the Field
static java.lang.String	COMMENTS Description of the Field
static java.lang.String	COMMERCIAL_FRAME Description of the Field
static java.lang.String	COMMERCIAL_INFO_URL Description of the Field
static java.lang.String	COMPOSER Description of the Field
static java.lang.String	CONDUCTOR Description of the Field
static java.lang.String	CONTENT_GROUP Description of the Field
static java.lang.String	CONTENT_TYPE Description of the Field
static java.lang.String	COPYRIGHT_INFO_URL Description of the Field
static java.lang.String	COPYRIGHT_MESSAGE Description of the Field
static java.lang.String	ENCODED_BY Description of the Field
static java.lang.String	ENCODING_TIME Description of the Field
static java.lang.String	ENCRYPTION_METHOD_REGISTRATION Description of the Field
static java.lang.String	EQUALISATION Description of the Field
static java.lang.String	EVENT_TIMING_CODES Description of the Field
static java.lang.String	FILE_OWNER Description of the Field
static java.lang.String	FILE_TYPE Description of the Field
static java.lang.String	GENERAL_ENCAPSULATED_OBJECT Description of the Field
static java.lang.String	GROUP_IDENTIFICATION_REGISTRATION Description of the Field
static java.lang.String	INITIAL_KEY Description of the Field
static java.lang.String	INTERNET_RADIO_STATION_NAME Description of the Field
static java.lang.String	INTERNET_RADIO_STATION_OWNER Description of the Field
static java.lang.String	INVOLVED_PEOPLE Description of the Field
static java.lang.String	ISRC Description of the Field
static java.lang.String	LANGUAGE Description of the Field
static java.lang.String	LEAD_PERFORMERS Description of the Field
static java.lang.String	LENGTH Description of the Field
static java.lang.String	LINKED_INFORMATION Description of the Field
static java.lang.String	LYRICIST Description of the Field
static java.lang.String	MEDIA_TYPE Description of the Field
static java.lang.String	MOOD Description of the Field
static java.lang.String	MPEG_LOCATION_LOOKUP_TABLE Description of the Field
static java.lang.String	MUSIC_CD_IDENTIFIER Description of the Field
static java.lang.String	MUSICIAN_CREDITS Description of the Field
static java.lang.String	OFFICIAL_ARTIST_WEBPAGE_URL Description of the Field
static java.lang.String	OFFICIAL_FILE_WEBPAGE_URL Description of the Field
static java.lang.String	OFFICIAL_INTERNET_RADIO_WEBPAGE_URL Description of the Field
static java.lang.String	OFFICIAL_PUBLISHER_WEBPAGE_URL Description of the Field
static java.lang.String	OFFICIAL_SOURCE_WEBPAGE_URL Description of the Field
static java.lang.String	ORIGINAL_ALBUM Description of the Field
static java.lang.String	ORIGINAL_ARTIST Description of the Field
static java.lang.String	ORIGINAL_FILENAME Description of the Field
static java.lang.String	ORIGINAL_LYRICIST Description of the Field
static java.lang.String	ORIGINAL_RELEASE_TIME Description of the Field
static java.lang.String	OWNERSHIP_FRAME Description of the Field
static java.lang.String	PART_OF_SET Description of the Field
static java.lang.String	PAYMENT_URL Description of the Field
static java.lang.String	PERFORMER_SORT_ORDER Description of the Field
static java.lang.String	PLAY_COUNTER Description of the Field
static java.lang.String	PLAYLIST_DELAY Description of the Field
static java.lang.String	POPULARIMETER Description of the Field
static java.lang.String	POSITION_SYNCHRONISATION_FRAME Description of the Field
static java.lang.String	PRIVATE_FRAME Description of the Field
static java.lang.String	PRODUCED_NOTICE Description of the Field
static java.lang.String	PUBLISHER Description of the Field
static java.lang.String	RECOMMENDED_BUFFER_SIZE Description of the Field
static java.lang.String	RECORDING_TIME Description of the Field
static java.lang.String	RELATIVE_VOLUME_ADJUSTMENT Description of the Field
static java.lang.String	RELEASE_TIME Description of the Field
static java.lang.String	REMIXED_BY Description of the Field
static java.lang.String	REVERB Description of the Field
static java.lang.String	SEEK_FRAME Description of the Field
static java.lang.String	SET_SUBTITLE Description of the Field
static java.lang.String	SIGNATURE_FRAME Description of the Field
static java.lang.String	SOFTWARE_HARDWARE_SETTINGS Description of the Field
static java.lang.String	SUBTITLE Description of the Field
static java.lang.String	SYNCHRONISED_LYRIC Description of the Field
static java.lang.String	SYNCHRONISED_TEMPO_CODES Description of the Field
static java.lang.String	TAGGING_TIME Description of the Field
static java.lang.String	TERMS_OF_USE Description of the Field
static java.lang.String	TITLE Description of the Field
static java.lang.String	TITLE_SORT_ORDER Description of the Field
static java.lang.String	TRACK_NUMBER Description of the Field
static java.lang.String	UNIQUE_FILE_IDENTIFIER Description of the Field
static java.lang.String	UNSYNCHRONISED_LYRIC_TRANSCRIPTION Description of the Field
static java.lang.String	USER_DEFINED_TEXT_INFO Description of the Field
static java.lang.String	USER_DEFINED_URL Description of the Field
static java.lang.String	YEAR Description of the Field

Constructor Summary

ID3v2Frames()

Method Summary

byte[]	getBytes() Return an array bytes containing all frames contained in this object.
int	getLength() Returns the length in bytes of all the frames contained in this object.
ID3v2Frame	put(java.lang.String key, ID3v2Frame value) Overrides the put method of HashMap.
java.lang.String	toString() Returns a string representation of this object.

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

ALBUM

public static java.lang.String ALBUM

Description of the Field

BPM

public static java.lang.String BPM

Description of the Field

COMPOSER

public static java.lang.String COMPOSER

Description of the Field

CONTENT_TYPE

public static java.lang.String CONTENT_TYPE

Description of the Field

COPYRIGHT_MESSAGE

public static java.lang.String COPYRIGHT_MESSAGE

Description of the Field

ENCODING_TIME

public static java.lang.String ENCODING_TIME

Description of the Field

PLAYLIST_DELAY

public static java.lang.String PLAYLIST_DELAY

Description of the Field

ORIGINAL_RELEASE_TIME

public static java.lang.String ORIGINAL_RELEASE_TIME

Description of the Field

RECORDING_TIME

public static java.lang.String RECORDING_TIME

Description of the Field

RELEASE_TIME

public static java.lang.String RELEASE_TIME

Description of the Field

TAGGING_TIME

public static java.lang.String TAGGING_TIME

Description of the Field

ENCODED_BY

public static java.lang.String ENCODED_BY

Description of the Field

LYRICIST

public static java.lang.String LYRICIST

Description of the Field

FILE_TYPE

public static java.lang.String FILE_TYPE

Description of the Field

INVOLVED_PEOPLE

public static java.lang.String INVOLVED_PEOPLE

Description of the Field

CONTENT_GROUP

public static java.lang.String CONTENT_GROUP

Description of the Field

TITLE

public static java.lang.String TITLE

Description of the Field

SUBTITLE

public static java.lang.String SUBTITLE

Description of the Field

INITIAL_KEY

public static java.lang.String INITIAL_KEY

Description of the Field

LANGUAGE

public static java.lang.String LANGUAGE

Description of the Field

LENGTH

public static java.lang.String LENGTH

Description of the Field

MUSICIAN_CREDITS

public static java.lang.String MUSICIAN_CREDITS

Description of the Field

MEDIA_TYPE

public static java.lang.String MEDIA_TYPE

Description of the Field

MOOD

public static java.lang.String MOOD

Description of the Field

ORIGINAL_ALBUM

public static java.lang.String ORIGINAL_ALBUM

Description of the Field

ORIGINAL_FILENAME

public static java.lang.String ORIGINAL_FILENAME

Description of the Field

ORIGINAL_LYRICIST

public static java.lang.String ORIGINAL_LYRICIST

Description of the Field

ORIGINAL_ARTIST

public static java.lang.String ORIGINAL_ARTIST

Description of the Field

FILE_OWNER

public static java.lang.String FILE_OWNER

Description of the Field

LEAD_PERFORMERS

public static java.lang.String LEAD_PERFORMERS

Description of the Field

ACCOMPANIMENT

public static java.lang.String ACCOMPANIMENT

Description of the Field

CONDUCTOR

public static java.lang.String CONDUCTOR

Description of the Field

REMIXED_BY

public static java.lang.String REMIXED_BY

Description of the Field

PART_OF_SET

public static java.lang.String PART_OF_SET

Description of the Field

PRODUCED_NOTICE

public static java.lang.String PRODUCED_NOTICE

Description of the Field

PUBLISHER

public static java.lang.String PUBLISHER

Description of the Field

TRACK_NUMBER

public static java.lang.String TRACK_NUMBER

Description of the Field

INTERNET_RADIO_STATION_NAME

public static java.lang.String INTERNET_RADIO_STATION_NAME

Description of the Field

INTERNET_RADIO_STATION_OWNER

public static java.lang.String INTERNET_RADIO_STATION_OWNER

Description of the Field

ALBUM_SORT_ORDER

public static java.lang.String ALBUM_SORT_ORDER

Description of the Field

PERFORMER_SORT_ORDER

public static java.lang.String PERFORMER_SORT_ORDER

Description of the Field

TITLE_SORT_ORDER

public static java.lang.String TITLE_SORT_ORDER

Description of the Field

ISRC

public static java.lang.String ISRC

Description of the Field

SOFTWARE_HARDWARE_SETTINGS

public static java.lang.String SOFTWARE_HARDWARE_SETTINGS

Description of the Field

SET_SUBTITLE

public static java.lang.String SET_SUBTITLE

Description of the Field

USER_DEFINED_TEXT_INFO

public static java.lang.String USER_DEFINED_TEXT_INFO

Description of the Field

YEAR

public static java.lang.String YEAR

Description of the Field

COMMERCIAL_INFO_URL

public static java.lang.String COMMERCIAL_INFO_URL

Description of the Field

COPYRIGHT_INFO_URL

public static java.lang.String COPYRIGHT_INFO_URL

Description of the Field

OFFICIAL_FILE_WEBPAGE_URL

public static java.lang.String OFFICIAL_FILE_WEBPAGE_URL

Description of the Field

OFFICIAL_ARTIST_WEBPAGE_URL

public static java.lang.String OFFICIAL_ARTIST_WEBPAGE_URL

Description of the Field

OFFICIAL_SOURCE_WEBPAGE_URL

public static java.lang.String OFFICIAL_SOURCE_WEBPAGE_URL

Description of the Field

OFFICIAL_INTERNET_RADIO_WEBPAGE_URL

public static java.lang.String OFFICIAL_INTERNET_RADIO_WEBPAGE_URL

Description of the Field

PAYMENT_URL

public static java.lang.String PAYMENT_URL

Description of the Field

OFFICIAL_PUBLISHER_WEBPAGE_URL

public static java.lang.String OFFICIAL_PUBLISHER_WEBPAGE_URL

Description of the Field

USER_DEFINED_URL

public static java.lang.String USER_DEFINED_URL

Description of the Field

AUDIO_ENCRYPTION

public static java.lang.String AUDIO_ENCRYPTION

Description of the Field

ATTACHED_PICTURE

public static java.lang.String ATTACHED_PICTURE

Description of the Field

AUDIO_SEEK_POINT_INDEX

public static java.lang.String AUDIO_SEEK_POINT_INDEX

Description of the Field

COMMENTS

public static java.lang.String COMMENTS

Description of the Field

COMMERCIAL_FRAME

public static java.lang.String COMMERCIAL_FRAME

Description of the Field

ENCRYPTION_METHOD_REGISTRATION

public static java.lang.String ENCRYPTION_METHOD_REGISTRATION

Description of the Field

EQUALISATION

public static java.lang.String EQUALISATION

Description of the Field

EVENT_TIMING_CODES

public static java.lang.String EVENT_TIMING_CODES

Description of the Field

GENERAL_ENCAPSULATED_OBJECT

public static java.lang.String GENERAL_ENCAPSULATED_OBJECT

Description of the Field

GROUP_IDENTIFICATION_REGISTRATION

public static java.lang.String GROUP_IDENTIFICATION_REGISTRATION

Description of the Field

LINKED_INFORMATION

public static java.lang.String LINKED_INFORMATION

Description of the Field

MUSIC_CD_IDENTIFIER

public static java.lang.String MUSIC_CD_IDENTIFIER

Description of the Field

MPEG_LOCATION_LOOKUP_TABLE

public static java.lang.String MPEG_LOCATION_LOOKUP_TABLE

Description of the Field

OWNERSHIP_FRAME

public static java.lang.String OWNERSHIP_FRAME

Description of the Field

PRIVATE_FRAME

public static java.lang.String PRIVATE_FRAME

Description of the Field

PLAY_COUNTER

public static java.lang.String PLAY_COUNTER

Description of the Field

POPULARIMETER

public static java.lang.String POPULARIMETER

Description of the Field

POSITION_SYNCHRONISATION_FRAME

public static java.lang.String POSITION_SYNCHRONISATION_FRAME

Description of the Field

RECOMMENDED_BUFFER_SIZE

public static java.lang.String RECOMMENDED_BUFFER_SIZE

Description of the Field

RELATIVE_VOLUME_ADJUSTMENT

public static java.lang.String RELATIVE_VOLUME_ADJUSTMENT

Description of the Field

REVERB

public static java.lang.String REVERB

Description of the Field

SEEK_FRAME

public static java.lang.String SEEK_FRAME

Description of the Field

SIGNATURE_FRAME

public static java.lang.String SIGNATURE_FRAME

Description of the Field

SYNCHRONISED_LYRIC

public static java.lang.String SYNCHRONISED_LYRIC

Description of the Field

SYNCHRONISED_TEMPO_CODES

public static java.lang.String SYNCHRONISED_TEMPO_CODES

Description of the Field

UNIQUE_FILE_IDENTIFIER

public static java.lang.String UNIQUE_FILE_IDENTIFIER

Description of the Field

TERMS_OF_USE

public static java.lang.String TERMS_OF_USE

Description of the Field

UNSYNCHRONISED_LYRIC_TRANSCRIPTION

public static java.lang.String UNSYNCHRONISED_LYRIC_TRANSCRIPTION

Description of the Field

Constructor Detail

ID3v2Frames

public ID3v2Frames()

Method Detail

getLength

public int getLength()

Returns the length in bytes of all the frames contained in this object. Empty frames are dropped from this calculation.

Returns:

the length of all the frames contained in this object.

getBytes

public byte[] getBytes()

Return an array bytes containing all frames contained in this object. This can be used to easily write the frames to a file. Empty frames are dropped to save space.

Returns:

an array of bytes contain all frames contained in this object

toString

public java.lang.String toString()

Returns a string representation of this object. Returns the toStrings of all the frames contained within seperated by line breaks.

Overrides:

toString in class java.util.AbstractMap

Returns:

a string representation of this object

put

public ID3v2Frame put(java.lang.String key,
                      ID3v2Frame value)

Overrides the put method of HashMap. Caters for getting an extended id from the object and also for duplicate tags

Returns:

previous value if a value was replaced