org.jaudiotagger.audio.asf.tag
Enum AsfFieldKey

java.lang.Object
  java.lang.Enum<AsfFieldKey>
      org.jaudiotagger.audio.asf.tag.AsfFieldKey

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AsfFieldKey>

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

Field keys which need to be mapped for ASF files, or only specified for ASF. TODO These attributes and their v23 mapping that havent been added to enum yet WMA ID3v1 ID3v22 ID3v2324 CopyrightURL WCP WCOP Duration TLE TLEN FileSize TSIZ WM/AudioFileURL WAF WOAF WM/AudioSourceURL WAS WOAS WM/Binary GEO GEOB WM/EncodingSettings TSS TSSE WM/EncodingTime TDEN WM/MCDI MCDI WM/ModifiedBy TPE4 WM/OriginalAlbumTitle TOT TOAL WM/OriginalArtist TOA TOPE WM/OriginalFilename TOF TOFN WM/OriginalLyricist TOL TOLY WM/OriginalReleaseYear TOR TORY WM/PlaylistDelay TDLY WM/RadioStationName TRN TRSN WM/RadioStationOwner TRO TRSO WM/SetSubTitle TSST WM/Text TXX TXXX WM/UniqueFileIdentifier UFI UFID WM/UserWebURL WXX WXXX

Author:

Christian Laireiter

Enum Constant Summary

ALBUM

ALBUM_ARTIST

ALBUM_ARTIST_SORT

ALBUM_SORT

AMAZON_ID

ARTIST_SORT

AUTHOR

BANNER_IMAGE

BANNER_IMAGE_TYPE

BANNER_IMAGE_URL

BARCODE

BPM

CATALOG_NO

CATEGORY

COMPOSER

COMPOSER_SORT

CONDUCTOR

COPYRIGHT

COPYRIGHT_URL

COVER_ART

COVER_ART_URL

CUSTOM

DESCRIPTION

DIRECTOR

DISC_NO

DISC_TOTAL

ENCODED_BY

ENCODER

GENRE

GENRE_ID

GROUPING

INITIAL_KEY

IS_COMPILATION

ISRC

ISVBR

LANGUAGE

LYRICIST

LYRICS

LYRICS_SYNCHRONISED

MEDIA

MOOD

MUSICBRAINZ_ARTISTID

MUSICBRAINZ_DISC_ID

MUSICBRAINZ_RELEASE_COUNTRY

MUSICBRAINZ_RELEASE_STATUS

MUSICBRAINZ_RELEASE_TYPE

MUSICBRAINZ_RELEASEARTISTID

MUSICBRAINZ_RELEASEID

MUSICBRAINZ_TRACK_ID

MUSICIP_ID

PRODUCER

RATING

RECORD_LABEL

REMIXER

SUBTITLE

TITLE

TITLE_SORT

TRACK

TRACK_TOTAL

URL_DISCOGS_ARTIST_SITE

URL_DISCOGS_RELEASE_SITE

URL_LYRICS_SITE

URL_OFFICIAL_ARTIST_SITE

URL_OFFICIAL_RELEASE_SITE

URL_PROMOTIONAL_SITE

URL_WIKIPEDIA_ARTIST_SITE

URL_WIKIPEDIA_RELEASE_SITE

YEAR

Field Summary

private static java.util.Map<java.lang.String,AsfFieldKey>	FIELD_ID_MAP Stores the fieldName to the field key.
private java.lang.String	fieldName If set, the field has a standard id assigned.
private ContainerType	highestContainer The highest possible container type, such a field can be stored into. High means, most capabilities, for example string length exceeds that of the extended content description, it will be stored one level up (metadata library).
private ContainerType	lowestContainer The lowest possible container type, such a field can be stored into. Low means, container with least capabilities.
private boolean	multiValued If true, the field will be stored repeatedly if occurs so in tags.

Method Summary

static AsfFieldKey	getAsfFieldKey(java.lang.String fieldName) Searches for an ASF field key which represents the given id string.
java.lang.String	getFieldName() Returns the standard field id.
ContainerType	getHighestContainer()
ContainerType	getLowestContainer()
boolean	isMultiValued() Returns true if this field can store multiple values.
static boolean	isMultiValued(java.lang.String fieldName) Tests whether the field is enabled for multiple values.
java.lang.String	toString()
static AsfFieldKey	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AsfFieldKey[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AUTHOR

public static final AsfFieldKey AUTHOR

TITLE

public static final AsfFieldKey TITLE

RATING

public static final AsfFieldKey RATING

COPYRIGHT

public static final AsfFieldKey COPYRIGHT

DESCRIPTION

public static final AsfFieldKey DESCRIPTION

BANNER_IMAGE

public static final AsfFieldKey BANNER_IMAGE

BANNER_IMAGE_TYPE

public static final AsfFieldKey BANNER_IMAGE_TYPE

BANNER_IMAGE_URL

public static final AsfFieldKey BANNER_IMAGE_URL

COPYRIGHT_URL

public static final AsfFieldKey COPYRIGHT_URL

ALBUM

public static final AsfFieldKey ALBUM

ALBUM_ARTIST

public static final AsfFieldKey ALBUM_ARTIST

ALBUM_ARTIST_SORT

public static final AsfFieldKey ALBUM_ARTIST_SORT

ALBUM_SORT

public static final AsfFieldKey ALBUM_SORT

AMAZON_ID

public static final AsfFieldKey AMAZON_ID

ARTIST_SORT

public static final AsfFieldKey ARTIST_SORT

BARCODE

public static final AsfFieldKey BARCODE

BPM

public static final AsfFieldKey BPM

CATALOG_NO

public static final AsfFieldKey CATALOG_NO

CATEGORY

public static final AsfFieldKey CATEGORY

COMPOSER

public static final AsfFieldKey COMPOSER

COMPOSER_SORT

public static final AsfFieldKey COMPOSER_SORT

CONDUCTOR

public static final AsfFieldKey CONDUCTOR

COVER_ART

public static final AsfFieldKey COVER_ART

COVER_ART_URL

public static final AsfFieldKey COVER_ART_URL

DIRECTOR

public static final AsfFieldKey DIRECTOR

DISC_NO

public static final AsfFieldKey DISC_NO

DISC_TOTAL

public static final AsfFieldKey DISC_TOTAL

ENCODER

public static final AsfFieldKey ENCODER

ENCODED_BY

public static final AsfFieldKey ENCODED_BY

GENRE

public static final AsfFieldKey GENRE

GENRE_ID

public static final AsfFieldKey GENRE_ID

GROUPING

public static final AsfFieldKey GROUPING

INITIAL_KEY

public static final AsfFieldKey INITIAL_KEY

IS_COMPILATION

public static final AsfFieldKey IS_COMPILATION

ISRC

public static final AsfFieldKey ISRC

ISVBR

public static final AsfFieldKey ISVBR

LANGUAGE

public static final AsfFieldKey LANGUAGE

LYRICIST

public static final AsfFieldKey LYRICIST

LYRICS

public static final AsfFieldKey LYRICS

LYRICS_SYNCHRONISED

public static final AsfFieldKey LYRICS_SYNCHRONISED

MEDIA

public static final AsfFieldKey MEDIA

MOOD

public static final AsfFieldKey MOOD

MUSICBRAINZ_ARTISTID

public static final AsfFieldKey MUSICBRAINZ_ARTISTID

MUSICBRAINZ_DISC_ID

public static final AsfFieldKey MUSICBRAINZ_DISC_ID

MUSICBRAINZ_RELEASE_COUNTRY

public static final AsfFieldKey MUSICBRAINZ_RELEASE_COUNTRY

MUSICBRAINZ_RELEASE_STATUS

public static final AsfFieldKey MUSICBRAINZ_RELEASE_STATUS

MUSICBRAINZ_RELEASE_TYPE

public static final AsfFieldKey MUSICBRAINZ_RELEASE_TYPE

MUSICBRAINZ_RELEASEARTISTID

public static final AsfFieldKey MUSICBRAINZ_RELEASEARTISTID

MUSICBRAINZ_RELEASEID

public static final AsfFieldKey MUSICBRAINZ_RELEASEID

MUSICBRAINZ_TRACK_ID

public static final AsfFieldKey MUSICBRAINZ_TRACK_ID

MUSICIP_ID

public static final AsfFieldKey MUSICIP_ID

PRODUCER

public static final AsfFieldKey PRODUCER

RECORD_LABEL

public static final AsfFieldKey RECORD_LABEL

REMIXER

public static final AsfFieldKey REMIXER

SUBTITLE

public static final AsfFieldKey SUBTITLE

TITLE_SORT

public static final AsfFieldKey TITLE_SORT

TRACK

public static final AsfFieldKey TRACK

TRACK_TOTAL

public static final AsfFieldKey TRACK_TOTAL

URL_DISCOGS_ARTIST_SITE

public static final AsfFieldKey URL_DISCOGS_ARTIST_SITE

URL_DISCOGS_RELEASE_SITE

public static final AsfFieldKey URL_DISCOGS_RELEASE_SITE

URL_OFFICIAL_ARTIST_SITE

public static final AsfFieldKey URL_OFFICIAL_ARTIST_SITE

URL_OFFICIAL_RELEASE_SITE

public static final AsfFieldKey URL_OFFICIAL_RELEASE_SITE

URL_PROMOTIONAL_SITE

public static final AsfFieldKey URL_PROMOTIONAL_SITE

URL_WIKIPEDIA_ARTIST_SITE

public static final AsfFieldKey URL_WIKIPEDIA_ARTIST_SITE

URL_WIKIPEDIA_RELEASE_SITE

public static final AsfFieldKey URL_WIKIPEDIA_RELEASE_SITE

URL_LYRICS_SITE

public static final AsfFieldKey URL_LYRICS_SITE

YEAR

public static final AsfFieldKey YEAR

CUSTOM

public static final AsfFieldKey CUSTOM

Field Detail

FIELD_ID_MAP

private static final java.util.Map<java.lang.String,AsfFieldKey> FIELD_ID_MAP

Stores the fieldName to the field key.

fieldName

private final java.lang.String fieldName

If set, the field has a standard id assigned.

multiValued

private final boolean multiValued

If true, the field will be stored repeatedly if occurs so in tags.

lowestContainer

private final ContainerType lowestContainer

The lowest possible container type, such a field can be stored into.
Low means, container with least capabilities.

highestContainer

private final ContainerType highestContainer

The highest possible container type, such a field can be stored into.
High means, most capabilities, for example string length exceeds that of the extended content description, it will be stored one level up (metadata library).

Method Detail

values

public static AsfFieldKey[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AsfFieldKey c : AsfFieldKey.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AsfFieldKey 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

java.lang.NullPointerException - if the argument is null

getAsfFieldKey

public static AsfFieldKey getAsfFieldKey(java.lang.String fieldName)

Searches for an ASF field key which represents the given id string.

Parameters:

fieldName - the field name used for this key

Returns:

the Enum that represents this field

isMultiValued

public static boolean isMultiValued(java.lang.String fieldName)

Tests whether the field is enabled for multiple values.

Parameters:

fieldName - field id to test.

Returns:

true if ASF implementation supports multiple values for the field.

getFieldName

public java.lang.String getFieldName()

Returns the standard field id.

Returns:

the standard field id. (may be null)

getHighestContainer

public ContainerType getHighestContainer()

Returns:

the highestContainer

getLowestContainer

public ContainerType getLowestContainer()

Returns:

the lowestContainer

isMultiValued

public boolean isMultiValued()

Returns true if this field can store multiple values.

Returns:

true if multiple values are supported for this field.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<AsfFieldKey>