org.jaudiotagger.tag.id3
Enum ID3v23FieldKey

java.lang.Object
  extended by java.lang.Enum<ID3v23FieldKey>
      extended by org.jaudiotagger.tag.id3.ID3v23FieldKey
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ID3v23FieldKey>

public enum ID3v23FieldKey
extends java.lang.Enum<ID3v23FieldKey>

List of known id3v23 metadata fields

These provide a mapping from the generic key to the underlying ID3v23frames. For example most of the Musicbrainz fields are implemnted using a User Defined Text Info Frame, but with a different description key, so this enum provides the link between the two.


Enum Constant Summary
ALBUM
           
ALBUM_ARTIST
           
ALBUM_ARTIST_SORT
           
ALBUM_SORT
           
AMAZON_ID
           
ARTIST
           
ARTIST_SORT
           
BPM
           
COMMENT
           
COMPOSER
           
COMPOSER_SORT
           
COVER_ART
           
DISC_NO
           
ENCODER
           
GENRE
           
GROUPING
           
IS_COMPILATION
           
LYRICS
           
MUSICBRAINZ_ARTISTID
           
MUSICBRAINZ_DISC_ID
           
MUSICBRAINZ_RELEASE_COUNTRY
           
MUSICBRAINZ_RELEASE_STATUS
           
MUSICBRAINZ_RELEASE_TYPE
           
MUSICBRAINZ_RELEASEARTISTID
           
MUSICBRAINZ_RELEASEID
           
MUSICBRAINZ_TRACK_ID
           
MUSICIP_ID
           
TITLE
           
TITLE_SORT
           
TRACK
           
YEAR
           
 
Method Summary
 java.lang.String getFieldName()
          This is the value of the key that can uniquely identifer a key type
 Id3FieldType getFieldType()
           
 java.lang.String getFrameId()
          This is the frame identifier used to write the field
 java.lang.String getSubId()
          This is the subfield used within the frame for this type of field
static ID3v23FieldKey valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ID3v23FieldKey[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ARTIST

public static final ID3v23FieldKey ARTIST

ALBUM

public static final ID3v23FieldKey ALBUM

TITLE

public static final ID3v23FieldKey TITLE

TRACK

public static final ID3v23FieldKey TRACK

YEAR

public static final ID3v23FieldKey YEAR

GENRE

public static final ID3v23FieldKey GENRE

COMMENT

public static final ID3v23FieldKey COMMENT

ALBUM_ARTIST

public static final ID3v23FieldKey ALBUM_ARTIST

COMPOSER

public static final ID3v23FieldKey COMPOSER

GROUPING

public static final ID3v23FieldKey GROUPING

DISC_NO

public static final ID3v23FieldKey DISC_NO

BPM

public static final ID3v23FieldKey BPM

ENCODER

public static final ID3v23FieldKey ENCODER

MUSICBRAINZ_ARTISTID

public static final ID3v23FieldKey MUSICBRAINZ_ARTISTID

MUSICBRAINZ_RELEASEID

public static final ID3v23FieldKey MUSICBRAINZ_RELEASEID

MUSICBRAINZ_RELEASEARTISTID

public static final ID3v23FieldKey MUSICBRAINZ_RELEASEARTISTID

MUSICBRAINZ_TRACK_ID

public static final ID3v23FieldKey MUSICBRAINZ_TRACK_ID

MUSICBRAINZ_DISC_ID

public static final ID3v23FieldKey MUSICBRAINZ_DISC_ID

MUSICIP_ID

public static final ID3v23FieldKey MUSICIP_ID

AMAZON_ID

public static final ID3v23FieldKey AMAZON_ID

MUSICBRAINZ_RELEASE_STATUS

public static final ID3v23FieldKey MUSICBRAINZ_RELEASE_STATUS

MUSICBRAINZ_RELEASE_TYPE

public static final ID3v23FieldKey MUSICBRAINZ_RELEASE_TYPE

MUSICBRAINZ_RELEASE_COUNTRY

public static final ID3v23FieldKey MUSICBRAINZ_RELEASE_COUNTRY

LYRICS

public static final ID3v23FieldKey LYRICS

IS_COMPILATION

public static final ID3v23FieldKey IS_COMPILATION

ARTIST_SORT

public static final ID3v23FieldKey ARTIST_SORT

ALBUM_ARTIST_SORT

public static final ID3v23FieldKey ALBUM_ARTIST_SORT

ALBUM_SORT

public static final ID3v23FieldKey ALBUM_SORT

TITLE_SORT

public static final ID3v23FieldKey TITLE_SORT

COMPOSER_SORT

public static final ID3v23FieldKey COMPOSER_SORT

COVER_ART

public static final ID3v23FieldKey COVER_ART
Method Detail

values

public static final ID3v23FieldKey[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(ID3v23FieldKey c : ID3v23FieldKey.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static ID3v23FieldKey valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

getFieldType

public Id3FieldType getFieldType()
Returns:
fieldtype

getFrameId

public java.lang.String getFrameId()
This is the frame identifier used to write the field

Returns:

getSubId

public java.lang.String getSubId()
This is the subfield used within the frame for this type of field

Returns:
subId

getFieldName

public java.lang.String getFieldName()
This is the value of the key that can uniquely identifer a key type

Returns: