ITunesMusicLibrary (beaTunes 4.6.16 API)

All Known Implementing Classes:

AbstractMusicLibrary, HibernateMusicLibrary
```
public interface ITunesMusicLibrary
```
Music library (despite the name, not specific to iTunes).

In prior versions, this interface returned Songs instead of AudioSongs. Since beaTunes 3, this has been changed. This allows you to simply call setters and not worry about calling store(com.tagtraum.audiokern.AudioSong, String) - changes are persisted automatically in the internal database, iTunes (or whatever other audioplayer, ITunes) as well as the file.

Author:

Hendrik Schreiber

See Also:

PlayList

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addITunesMusicLibraryListener(ITunesMusicLibraryListener listener)`
`void`	`addPlayListDataListener(ListDataListener l)`
`void`	`addPlayListPropertyChangeListener(PropertyChangeListener propertyChangeListener)` Lets you register a listener that receives events when a playlist property is changed.
`void`	`addPlayListPropertyChangeListener(String property, PropertyChangeListener propertyChangeListener)` Lets you register a listener that receives events when a playlist property is changed.
`void`	`addPropertyChangeListener(PropertyChangeListener propertyChangeListener)`
`void`	`addPropertyChangeListener(String property, PropertyChangeListener propertyChangeListener)`
`int`	`countSongs()` Number of songs in the library.
`int`	`countSongsWithPropertyValue(String propertyName, Object propertyValue)` Count all songs with a property `equal` to the given value.
`int`	`countUnprotectedSongsAddedAfter(Date time)`
`PlayList`	`createFolder()` Creates a new folder under the Music playlist/folder.
`PlayList`	`createFolder(Long parentId)` Creates a new folder at a specific location.
`PlayList`	`createPlayList(Long id, Long parentId, String name, boolean folder)` Creates a new `PlayList` object with the given name and id.
`PlayList`	`createPlayList(Long parentId, String name)` Creates a new PlayList at a specific location.
`PlayList`	`createPlayList(String name)` Creates a new PlayList under the Music playlist/folder.
`void`	`deletePlayList(long id)` Deletes a playlist from the library.
`AudioSong`	`fetchCollections(AudioSong song)` Loads dependent collections that otherwise wouldn't have been loaded.
`void`	`flushPendingWrites()` Flush any pending writes (blocks until all writes happened).
`Set<Set<Long>>`	`getAcousticallyIdenticalSongIds()` Returns a collection of sets that each contain song ids of acoustically "identical" songs.
`Set<Set<Long>>`	`getAcousticallyIdenticalSongIds(int maxSubprintMatchAttempts)` Returns a collection of sets that each contain song ids of acoustically "identical" songs.
`Album`	`getAlbum(Album.Key key)` Deprecated.
`Set<Album.Key>`	`getAlbumKeys()` Returns the set of all valid album keys.
`List<Long>`	`getAlbumSongIds(String album, String artist)` Returns a list of song ids for songs specified by the given album and artist.
`List<AudioSong>`	`getAlbumSongs(String album, String artist)` Returns a list of songs specified by the given album and artist.
`Set<Album.Key>`	`getAllTimesFavoriteAlbums(int max)`
`Version`	`getApplicationVersion()` Returns the iTunes application version as specified in the iTunes Music Library.xml.
`ExecutorService`	`getAudioMetaDataExecutor()` Returns en executor service that should be used for any write access to `AudioMetaData` related tasks.
`File`	`getDatabaseDir()`
`List<String>`	`getDuplicateTitles()` Returns a list of titles that have exact duplicates.
`List<String>`	`getDuplicateTrackIds()` Returns a list of track ids that correspond to more than one song.
`List<String>`	`getGenres()`
`Set<Album.Key>`	`getHighlyRatedAlbums(int max)`
`<T> T`	`getImplementation(Class<T> klass)`
`long`	`getLastSynchronizationTimestamp()` Timestamp of last synchronization of the current library.
`PlayList`	`getLibrary()` Returns the master playlist that contains all library objects.
`LibraryDescriptor`	`getLibraryDescriptor()` Returns the library descriptor.
`ReentrantLock`	`getLock(Long songId)` Provides a lock object for a song id.
`Long`	`getPersistentId()` Returns the iTunes library persistent id as specified in the `iTunes Music Library.xml`.
`PlayList`	`getPlayList(long playListPersistentId)` Get a `PlayList` for an id.
`PropertyChangeListener[]`	`getPlayListPropertyChangeListeners()`
`PropertyChangeListener[]`	`getPlayListPropertyChangeListeners(String property)`
`List<PlayList>`	`getPlayLists()` List of all playlists.
`TagCollection`	`getPopularTagCollection(int numberOfTags)` Returns the `TagCollection` for the X most common tags.
`long`	`getPreviousToLastSynchronizationTimestamp()` Timestamp of the previous to last synchronization of the current library.
`PropertyChangeListener[]`	`getPropertyChangeListeners()`
`PropertyChangeListener[]`	`getPropertyChangeListeners(String property)`
`Set<Album.Key>`	`getRecentlyAddedAlbums(int max)`
`Set<Album.Key>`	`getRecentlyPlayedAlbums(int max)`
`Collection<Set<Long>>`	`getSimilarTitles()` Returns a collection of id sets that point to songs with similar or identical titles.
`AudioSong`	`getSong(Long id)` Gets a Song, given its id (`Song.getId()`.
`List<Long>`	`getSongIds()` Returns an `Iterable` that can be used to iterate over all song ids.
`Set<Long>`	`getSongIds(PlayList.Kind... kinds)` Returns all ids that are in the given set of `PlayList.Kind`s.
`List<Long>`	`getSongIdsWithoutPropertyValue(String propertyName, Object propertyValue)` Get all song ids of songs with a property `equal` the given value.
`List<Long>`	`getSongIdsWithPropertyLikeValue(String propertyName, String propertyValue)` Get all song ids of songs with a property `like` the given value.
`List<Long>`	`getSongIdsWithPropertyValue(String propertyName, Object propertyValue)` Get all song ids for songs with a property `equal` to the given value.
`<T> List<T>`	`getSongPropertyValues(String propertyName)` All possible values for a given property.
`<T> List<T>`	`getSongPropertyValues(String propertyName, List<T> valueList)` All possible values for a given property.
`<T> List<T>`	`getSongPropertyValues(String propertyName, String restrictionPropertyName, Object restrictionPropertyValue)` Gets all property values of property `propertyName` for songs with `restrictionPropertyName` equaling `restrictionPropertyValue`.
`Iterable<AudioSong>`	`getSongs()` Returns an `Iterable` that can be used to iterate over all songs.
`Iterable<AudioSong>`	`getSongs(Collection<Long> ids)` Returns an `Iterable` that can be used to iterate over the specified songs.
`List<AudioSong>`	`getSongsWithFileAndSize(String filename, int size)` Deprecated.
`List<AudioSong>`	`getSongsWithNameArtistAlbumTotalTime(String name, String artist, String album, int time)` Deprecated.
`List<AudioSong>`	`getSongsWithoutPropertyValue(String propertyName, Object propertyValue)` Get all songs with a property `not equal` to the given value.
`List<AudioSong>`	`getSongsWithPropertyLikeValue(String propertyName, String propertyValue)` Get all songs with a property `like` the given value.
`List<AudioSong>`	`getSongsWithPropertyValue(String propertyName, Object propertyValue)` Get all songs with a property `equal` to the given value.
`Set<AudioSong>`	`getSongsWithTrackIdTotalTime(Set<AudioId> ids, int time)` Deprecated.
`TagCollection`	`getTagCollection()` Returns the `TagCollection` for the entire library.
`ITunes`	`getTunes()` Returns the currently associated audio player, probably iTunes.
`ExecutorService`	`getTunesExecutor()` Returns en executor service that should be used for any write access to `ITunes` related tasks.
`List<AudioSong>`	`getUnprotectedSongsAddedAfter(Date time)`
`void`	`init()` Initializes this component and its sub-components.
`boolean`	`isEmbedAudioMetaData()`
`boolean`	`isNewDatabase()`
`boolean`	`isOneWeekOld()`
`boolean`	`isSynchronizing()`
`Lock`	`lock(Long songId)` Provides a locked lock for a song id.
`boolean`	`needsRefresh()`
`void`	`refresh()` Reloads all objects that are connected to the music library.
`void`	`refresh(boolean blockingCall, boolean manuallyInitiated)` Reloads all objects that are connected to the music library.
`void`	`removePlayListDataListener(ListDataListener l)`
`void`	`removePlayListPropertyChangeListener(PropertyChangeListener propertyChangeListener)`
`void`	`removePlayListPropertyChangeListener(String property, PropertyChangeListener propertyChangeListener)`
`void`	`removePropertyChangeListener(PropertyChangeListener propertyChangeListener)`
`void`	`removePropertyChangeListener(String property, PropertyChangeListener propertyChangeListener)`
`<V> V`	`serialExecute(Callable<V> callable)` Execute the callable with `getTunesExecutor()`, but not before `getAudioMetaDataExecutor()` has run through.
`void`	`serialExecute(Runnable runnable)` Execute the runnable with `getTunesExecutor()`, but not before `getAudioMetaDataExecutor()` has run through.
`void`	`setDatabaseDir(File databaseDir)`
`void`	`setEmbedAudioMetaData(boolean embedAudioMetaData)`
`void`	`setLibraryDescriptor(LibraryDescriptor libraryDescriptor)` Sets the library descriptor.
`void`	`setNewDatabase(boolean newDatabase)`
`void`	`setUIDelegate(MusicLibraryUIDelegate uiDelegate)`
`void`	`shutdown()` Shuts down this component and its sub-components.
`<V> V`	`smuggle(Callable<V> callable)` Smuggles read-only calls to the `getTunesExecutor()` even when it's blocked.
`void`	`store(AudioSong song)` Stores a song in the beaTunes database.
`void`	`store(AudioSong song, String changedProperty)` Stores a song in the beaTunes database and clears any sortorder caches in the playlist objects this song might be in, if the playlist is sorted by the changed property.
`void`	`store(Iterable<AudioSong> songs)` Stores a collection of songs in the beaTunes database.
`void`	`store(MatchListInfo matchListInfo)` Store the given info.
`void`	`store(PlayList playList)` Stores a playlist in the beaTunes database.

- Method Detail
  - getImplementation
```
<T> T getImplementation(Class<T> klass)
```
  - init
```
void init()
```
    Initializes this component and its sub-components.
  - shutdown
```
void shutdown()
       throws ShutdownVetoException
```
    Shuts down this component and its sub-components.
    
    Throws:
    
    ShutdownVetoException - if this component wants to veto the shutdown. This exception is not guaranteed to be honored, i.e. a calling component may simply ignore it
  - getTunesExecutor
```
ExecutorService getTunesExecutor()
```
    Returns en executor service that should be used for any write access to ITunes related tasks. This takes care of synchronizing your access as well as using the correct thread.
    Typically when working with AudioSong objects, synchronization happens behind the scenes, so you don't have to use this service. However, there may be situations in which you want to access a Track directly. If you intend to write, you should use this executor.
    The service is managed by the application, i.e. you cannot terminate or shut it down.
    
    Returns:
    
    executor service
    
    See Also:
    
    TunesUtilities.getExecutorService()
  - getAudioMetaDataExecutor
```
ExecutorService getAudioMetaDataExecutor()
```
    Returns en executor service that should be used for any write access to AudioMetaData related tasks. This takes care of synchronizing your access as well as using the correct thread.
    Typically when working with AudioSong objects, synchronization happens behind the scenes, so you don't have to use this service. However, there may be situations in which you want to access a AudioMetaData directly. If you intend to write, you should use this executor.
    The service is managed by the application, i.e. you cannot terminate or shut it down.
    
    Returns:
    
    executor service
    
    See Also:
    
    AudioMetaData.getExecutorService()
  - serialExecute
```
<V> V serialExecute(Callable<V> callable)
             throws Exception
```
    Execute the callable with getTunesExecutor(), but not before getAudioMetaDataExecutor() has run through.
    
    Type Parameters:
    
    V - return type
    
    Parameters:
    
    callable - callable
    
    Returns:
    
    return value, may be null
    
    Throws:
    
    Exception
  - serialExecute
```
void serialExecute(Runnable runnable)
```
    Execute the runnable with getTunesExecutor(), but not before getAudioMetaDataExecutor() has run through.
    
    Parameters:
    
    runnable - runnable
  - smuggle
```
<V> V smuggle(Callable<V> callable)
       throws Exception
```
    Smuggles read-only calls to the getTunesExecutor() even when it's blocked.
    
    Type Parameters:
    
    V - return type
    
    Parameters:
    
    callable - callable
    
    Returns:
    
    return value, may be null
    
    Throws:
    
    Exception
  - getLock
```
ReentrantLock getLock(Long songId)
```
    Provides a lock object for a song id.
    
    Parameters:
    
    songId - song id
    
    Returns:
    
    exclusive, reentrant lock
  - lock
```
Lock lock(Long songId)
```
    Provides a locked lock for a song id.
    
    Parameters:
    
    songId - song id
    
    Returns:
    
    exclusive, reentrant lock
  - getTunes
```
ITunes getTunes()
```
    Returns the currently associated audio player, probably iTunes.
    
    Returns:
    
    audio player
  - isNewDatabase
```
boolean isNewDatabase()
```
  - setNewDatabase
```
void setNewDatabase(boolean newDatabase)
```
  - countSongs
```
int countSongs()
```
    Number of songs in the library.
    
    Returns:
    
    number of songs in the library.
  - countSongsWithPropertyValue
```
int countSongsWithPropertyValue(String propertyName,
                                Object propertyValue)
```
    Count all songs with a property equal to the given value.
    
    Parameters:
    
    propertyName - name of a property
    
    propertyValue - value of a property
    
    Returns:
    
    list of songs whose property has the required value
  - getSongsWithPropertyValue
```
List<AudioSong> getSongsWithPropertyValue(String propertyName,
                                          Object propertyValue)
```
    Get all songs with a property equal to the given value.
    
    Parameters:
    
    propertyName - name of a property
    
    propertyValue - value of a property
    
    Returns:
    
    list of songs whose property has the required value
  - getSongIdsWithPropertyValue
```
List<Long> getSongIdsWithPropertyValue(String propertyName,
                                       Object propertyValue)
```
    Get all song ids for songs with a property equal to the given value.
    
    Parameters:
    
    propertyName - name of a property
    
    propertyValue - value of a property
    
    Returns:
    
    list of song ids whose property has the required value
  - getSongsWithoutPropertyValue
```
List<AudioSong> getSongsWithoutPropertyValue(String propertyName,
                                             Object propertyValue)
```
    Get all songs with a property not equal to the given value.
    
    Parameters:
    
    propertyName - name of a property
    
    propertyValue - value of a property
    
    Returns:
    
    list of songs whose property does not have the given value
    
    See Also:
    
    getSongIdsWithoutPropertyValue(String, Object)
  - getSongIdsWithoutPropertyValue
```
List<Long> getSongIdsWithoutPropertyValue(String propertyName,
                                          Object propertyValue)
```
    Get all song ids of songs with a property equal the given value.
    
    Parameters:
    
    propertyName - name of a property
    
    propertyValue - value of a property
    
    Returns:
    
    list of song ids whose property does not have the given value
    
    See Also:
    
    getSongsWithoutPropertyValue(String, Object)
  - getSongsWithPropertyLikeValue
```
List<AudioSong> getSongsWithPropertyLikeValue(String propertyName,
                                              String propertyValue)
```
    Get all songs with a property like the given value.
    
    Parameters:
    
    propertyName - name of a property
    
    propertyValue - value of a string property
    
    Returns:
    
    list of songs whose string property contains the given value
    
    See Also:
    
    getSongIdsWithPropertyLikeValue(String, String)
  - getSongIdsWithPropertyLikeValue
```
List<Long> getSongIdsWithPropertyLikeValue(String propertyName,
                                           String propertyValue)
```
    Get all song ids of songs with a property like the given value.
    
    Parameters:
    
    propertyName - name of a property
    
    propertyValue - value of a string property
    
    Returns:
    
    list of song ids whose string property contains the given value
    
    See Also:
    
    getSongsWithPropertyLikeValue(String, String)
  - getSongs
```
Iterable<AudioSong> getSongs()
```
    Returns an Iterable that can be used to iterate over all songs. Shortcut for getLibrary().getSongs(). Note that the Iterable may be a List, which would expose other means of dealing with the content.
    
    Returns:
    
    an object from which one can get an iterator
  - getSongs
```
Iterable<AudioSong> getSongs(Collection<Long> ids)
```
    Returns an Iterable that can be used to iterate over the specified songs.
    
    Parameters:
    
    ids - collection of ids
    
    Returns:
    
    an object from which one can get an iterator
  - getSongIds
```
List<Long> getSongIds()
```
    Returns an Iterable that can be used to iterate over all song ids.
    
    Returns:
    
    an object from which one can get an iterator
  - getSongIds
```
Set<Long> getSongIds(PlayList.Kind... kinds)
```
    Returns all ids that are in the given set of PlayList.Kinds.
    
    Parameters:
    
    kinds - kind
    
    Returns:
    
    set of ids
  - getSong
```
AudioSong getSong(Long id)
```
    Gets a Song, given its id (Song.getId().
    
    Parameters:
    
    id - id
    
    Returns:
    
    song or null, if not found
  - fetchCollections
```
AudioSong fetchCollections(AudioSong song)
```
    Loads dependent collections that otherwise wouldn't have been loaded. Default impl. does nothing.
    
    Parameters:
    
    song - song to 'complete'
    
    Returns:
    
    song complete with associated collections
  - getGenres
```
List<String> getGenres()
```
    Returns:
    
    unsorted list of all non-null genre names.
  - getSongPropertyValues
```
<T> List<T> getSongPropertyValues(String propertyName)
```
    All possible values for a given property.
    
    Parameters:
    
    propertyName - property
    
    Returns:
    
    values for a given property
  - getSongPropertyValues
```
<T> List<T> getSongPropertyValues(String propertyName,
                                  List<T> valueList)
```
    All possible values for a given property.
    
    Parameters:
    
    propertyName - property
    
    valueList - list that this method will add the results to. Before the results are added, the list is cleared.
    
    Returns:
    
    values for a given property
  - getSongPropertyValues
```
<T> List<T> getSongPropertyValues(String propertyName,
                                  String restrictionPropertyName,
                                  Object restrictionPropertyValue)
```
    Gets all property values of property propertyName for songs with restrictionPropertyName equaling restrictionPropertyValue.
    
    Parameters:
    
    propertyName - properties whose values are going to be returned
    
    restrictionPropertyName - property that is used to select the return set
    
    restrictionPropertyValue - property value that is used to select the return set
    
    Returns:
    
    values of propertyName
  - getDuplicateTitles
```
List<String> getDuplicateTitles()
```
    Returns a list of titles that have exact duplicates.
    
    Returns:
    
    list of duplicate titles
    
    See Also:
    
    getSimilarTitles()
  - getDuplicateTrackIds
```
List<String> getDuplicateTrackIds()
```
    Returns a list of track ids that correspond to more than one song.
    
    Returns:
    
    list of duplicate ids
    
    See Also:
    
    getSimilarTitles()
  - getAcousticallyIdenticalSongIds
```
Set<Set<Long>> getAcousticallyIdenticalSongIds()
```
    Returns a collection of sets that each contain song ids of acoustically "identical" songs. Only songs that have fingerprints (see AudioSong.setFingerprint(byte[])) can be found.
    
    Returns:
    
    set of id sets
    
    See Also:
    
    getAcousticallyIdenticalSongIds(int)
  - getAcousticallyIdenticalSongIds
```
Set<Set<Long>> getAcousticallyIdenticalSongIds(int maxSubprintMatchAttempts)
```
    Returns a collection of sets that each contain song ids of acoustically "identical" songs. Only songs that have fingerprints (see AudioSong.setFingerprint(byte[])) can be found.
    
    Parameters:
    
    maxSubprintMatchAttempts - maximum number of attempts to match a subprint. Negative values cause an exhaustive search (longer runtime). The default value used in getAcousticallyIdenticalSongIds() is 15.
    
    Returns:
    
    set of id sets
    
    See Also:
    
    getAcousticallyIdenticalSongIds()
  - getSimilarTitles
```
Collection<Set<Long>> getSimilarTitles()
```
    Returns a collection of id sets that point to songs with similar or identical titles.
    
    Returns:
    
    collection of id sets
    
    See Also:
    
    getDuplicateTitles()
  - getLibrary
```
PlayList getLibrary()
```
    Returns the master playlist that contains all library objects. This may also be unexpected objects like apps. For just Music objects, get the playlist with kind PlayList.Kind.MUSIC (testable via PlayList.getDistinguishedKind()).
    
    Returns:
    
    master playlist
  - getPlayLists
```
List<PlayList> getPlayLists()
```
    List of all playlists.
    
    Returns:
    
    list of all playlists in the library
  - getPlayList
```
PlayList getPlayList(long playListPersistentId)
```
    Get a PlayList for an id.
    
    Parameters:
    
    playListPersistentId - persistent id
    
    Returns:
    
    the playlist corresponding to the id or null, if it does not exist
  - createPlayList
```
PlayList createPlayList(Long parentId,
                        String name)
```
    Creates a new PlayList at a specific location.
    
    Parameters:
    
    parentId - persistent id of the parent, i.e. the location of the playlist to newly create
    
    name - name
    
    Returns:
    
    new playlist object.
  - createPlayList
```
PlayList createPlayList(String name)
```
    Creates a new PlayList under the Music playlist/folder.
    
    Parameters:
    
    name - name
    
    Returns:
    
    new playlist object.
  - createFolder
```
PlayList createFolder(Long parentId)
```
    Creates a new folder at a specific location.
    
    Parameters:
    
    parentId - persistent id of the parent, i.e. the location of the folder to newly create
    
    Returns:
    
    new folder object.
  - createFolder
```
PlayList createFolder()
```
    Creates a new folder under the Music playlist/folder.
    
    Returns:
    
    new folder object.
  - createPlayList
```
PlayList createPlayList(Long id,
                        Long parentId,
                        String name,
                        boolean folder)
```
    Creates a new PlayList object with the given name and id.
    
    Parameters:
    
    id - persistentId
    
    parentId - parent playlist persistent id - may be null, if there is no parent
    
    name - name
    
    folder - is folder
    
    Returns:
    
    a new persistent playlist
  - getAlbum
```
@Deprecated
Album getAlbum(Album.Key key)
```
    Deprecated.
    
    Returns an album. The songs contained in this album are not properly wrapped. Writing to them most likely does not work as expected.
    
    Parameters:
    
    key - album key, interpreted case-insensitively
    
    Returns:
    
    album
    
    See Also:
    
    getAlbumSongs(String, String)
  - getAlbumSongIds
```
List<Long> getAlbumSongIds(String album,
                           String artist)
```
    Returns a list of song ids for songs specified by the given album and artist. At least on of the two parameters must be a non-empty string. The lookup is case-sensitive. To find valid album/artist combinations, check getAlbumKeys().
    
    Parameters:
    
    album - album
    
    artist - artist or album artist
    
    Returns:
    
    list of ids
    
    See Also:
    
    getAlbumSongs(String, String), getAlbumKeys()
  - getAlbumSongs
```
List<AudioSong> getAlbumSongs(String album,
                              String artist)
```
    Returns a list of songs specified by the given album and artist. At least one of the two parameters must be a non-empty string. The lookup is case-sensitive. To find valid album/artist combinations, check getAlbumKeys().
    
    Parameters:
    
    album - album
    
    artist - artist or album artist
    
    Returns:
    
    list of songs
    
    See Also:
    
    getAlbumSongIds(String, String), getAlbumKeys()
  - getAlbumKeys
```
Set<Album.Key> getAlbumKeys()
```
    Returns the set of all valid album keys. To qualify for the set, both an album and either an artist or an album artist must be set.
    
    Returns:
    
    album keys
  - getRecentlyPlayedAlbums
```
Set<Album.Key> getRecentlyPlayedAlbums(int max)
```
  - getHighlyRatedAlbums
```
Set<Album.Key> getHighlyRatedAlbums(int max)
```
  - getAllTimesFavoriteAlbums
```
Set<Album.Key> getAllTimesFavoriteAlbums(int max)
```
  - getRecentlyAddedAlbums
```
Set<Album.Key> getRecentlyAddedAlbums(int max)
```
  - getSongsWithFileAndSize
```
@Deprecated
List<AudioSong> getSongsWithFileAndSize(String filename,
                                                    int size)
```
    Deprecated.
  - getSongsWithNameArtistAlbumTotalTime
```
@Deprecated
List<AudioSong> getSongsWithNameArtistAlbumTotalTime(String name,
                                                                 String artist,
                                                                 String album,
                                                                 int time)
```
    Deprecated.
  - getSongsWithTrackIdTotalTime
```
@Deprecated
Set<AudioSong> getSongsWithTrackIdTotalTime(Set<AudioId> ids,
                                                        int time)
```
    Deprecated.
  - countUnprotectedSongsAddedAfter
```
int countUnprotectedSongsAddedAfter(Date time)
```
  - getUnprotectedSongsAddedAfter
```
List<AudioSong> getUnprotectedSongsAddedAfter(Date time)
```
  - getPopularTagCollection
```
TagCollection getPopularTagCollection(int numberOfTags)
```
    Returns the TagCollection for the X most common tags.
    
    Parameters:
    
    numberOfTags - max number of tags to return
    
    Returns:
    
    tag collection for strongest tags in the library
  - getTagCollection
```
TagCollection getTagCollection()
```
    Returns the TagCollection for the entire library.
    
    Returns:
    
    tag collection for the library
  - store
```
void store(PlayList playList)
```
    Stores a playlist in the beaTunes database.
    
    Parameters:
    
    playList - playlist to save
  - store
```
void store(AudioSong song)
```
    Stores a song in the beaTunes database.
    
    The write-process is asynchronous, i.e. this method may return before the songs has actually been written.
    
    Parameters:
    
    song - song to save
  - store
```
void store(AudioSong song,
           String changedProperty)
```
    Stores a song in the beaTunes database and clears any sortorder caches in the playlist objects this song might be in, if the playlist is sorted by the changed property.
    
    The write-process is asynchronous, i.e. this method may return before the songs has actually been written.
    
    Parameters:
    
    song - song to save
    
    changedProperty - property that has been changed (may be null, if multiple properties have changed or the change is unknown)
  - store
```
void store(Iterable<AudioSong> songs)
```
    Stores a collection of songs in the beaTunes database.
    
    The write-process is asynchronous, i.e. this method may return before the songs has actually been written.
    
    Parameters:
    
    songs - songs to save
  - flushPendingWrites
```
void flushPendingWrites()
                 throws InterruptedException
```
    Flush any pending writes (blocks until all writes happened).
    
    Throws:
    
    InterruptedException
  - deletePlayList
```
void deletePlayList(long id)
```
    Deletes a playlist from the library.
    
    Parameters:
    
    id - id
  - getLastSynchronizationTimestamp
```
long getLastSynchronizationTimestamp()
```
    Timestamp of last synchronization of the current library.
    
    Returns:
    
    timestamp or 0, if unknown
  - getPreviousToLastSynchronizationTimestamp
```
long getPreviousToLastSynchronizationTimestamp()
```
    Timestamp of the previous to last synchronization of the current library.
    
    Returns:
    
    timestamp or 0, if unknown
  - setLibraryDescriptor
```
void setLibraryDescriptor(LibraryDescriptor libraryDescriptor)
```
    Sets the library descriptor.
    
    Parameters:
    
    libraryDescriptor - library descriptor
  - getLibraryDescriptor
```
LibraryDescriptor getLibraryDescriptor()
```
    Returns the library descriptor. Use this method to find out, what kind of library you are dealing with.
    
    Returns:
    
    library descriptor
    
    See Also:
    
    ITunesLibraryDescriptor, FileSystemLibraryDescriptor
  - getApplicationVersion
```
Version getApplicationVersion()
```
    Returns the iTunes application version as specified in the iTunes Music Library.xml.
    
    Returns:
    
    iTunes application version
  - getPersistentId
```
Long getPersistentId()
```
    Returns the iTunes library persistent id as specified in the iTunes Music Library.xml.
    
    Returns:
    
    persistent library id as long
  - refresh
```
void refresh()
      throws IOException,
             ParserConfigurationException,
             SAXException
```
    Reloads all objects that are connected to the music library. If this is the first time we are loading the library, it will be done synchronously. After that it will be done asynchronously.
    
    Throws:
    
    IOException
    
    ParserConfigurationException
    
    SAXException
  - refresh
```
void refresh(boolean blockingCall,
             boolean manuallyInitiated)
      throws IOException,
             ParserConfigurationException,
             SAXException
```
    Reloads all objects that are connected to the music library.
    
    Parameters:
    
    blockingCall - flag to indicate whether this call should return right away or not.
    
    manuallyInitiated - indicates whether this refresh was directly triggered by some user action
    
    Throws:
    
    IOException
    
    ParserConfigurationException
    
    SAXException
  - needsRefresh
```
boolean needsRefresh()
```
    Returns:
    
    true, if the library is based on an xml files and was changed. Or if we cannot determine, if a refresh is really necessary
  - isOneWeekOld
```
boolean isOneWeekOld()
```
    Returns:
    
    true if the iTunes (Music) Library.xml file is older than one week.
    
    See Also:
    
    getLibraryDescriptor()
  - addITunesMusicLibraryListener
```
void addITunesMusicLibraryListener(ITunesMusicLibraryListener listener)
```
  - store
```
void store(MatchListInfo matchListInfo)
```
    Store the given info.
    
    Parameters:
    
    matchListInfo - match list info
  - isEmbedAudioMetaData
```
boolean isEmbedAudioMetaData()
```
  - setEmbedAudioMetaData
```
void setEmbedAudioMetaData(boolean embedAudioMetaData)
```
  - setUIDelegate
```
void setUIDelegate(MusicLibraryUIDelegate uiDelegate)
```
  - setDatabaseDir
```
void setDatabaseDir(File databaseDir)
```
  - getDatabaseDir
```
File getDatabaseDir()
```
  - addPropertyChangeListener
```
void addPropertyChangeListener(PropertyChangeListener propertyChangeListener)
```
  - addPropertyChangeListener
```
void addPropertyChangeListener(String property,
                               PropertyChangeListener propertyChangeListener)
```
  - addPlayListPropertyChangeListener
```
void addPlayListPropertyChangeListener(PropertyChangeListener propertyChangeListener)
```
    Lets you register a listener that receives events when a playlist property is changed. Unlike listeners bound to individual, transient playlist objects, this registration is permanent as long as this library is available.
    
    Parameters:
    
    propertyChangeListener - listener
  - addPlayListPropertyChangeListener
```
void addPlayListPropertyChangeListener(String property,
                                       PropertyChangeListener propertyChangeListener)
```
    Lets you register a listener that receives events when a playlist property is changed. Unlike listeners bound to individual, transient playlist objects, this registration is permanent as long as this library is available.
    
    Parameters:
    
    propertyChangeListener - listener
    
    property - property
  - removePlayListPropertyChangeListener
```
void removePlayListPropertyChangeListener(PropertyChangeListener propertyChangeListener)
```
  - removePlayListPropertyChangeListener
```
void removePlayListPropertyChangeListener(String property,
                                          PropertyChangeListener propertyChangeListener)
```
  - getPlayListPropertyChangeListeners
```
PropertyChangeListener[] getPlayListPropertyChangeListeners()
```
  - getPlayListPropertyChangeListeners
```
PropertyChangeListener[] getPlayListPropertyChangeListeners(String property)
```
  - removePropertyChangeListener
```
void removePropertyChangeListener(PropertyChangeListener propertyChangeListener)
```
  - removePropertyChangeListener
```
void removePropertyChangeListener(String property,
                                  PropertyChangeListener propertyChangeListener)
```
  - getPropertyChangeListeners
```
PropertyChangeListener[] getPropertyChangeListeners()
```
  - getPropertyChangeListeners
```
PropertyChangeListener[] getPropertyChangeListeners(String property)
```
  - addPlayListDataListener
```
void addPlayListDataListener(ListDataListener l)
```
  - removePlayListDataListener
```
void removePlayListDataListener(ListDataListener l)
```
  - isSynchronizing
```
boolean isSynchronizing()
```

Interface ITunesMusicLibrary

Method Summary

Method Detail

getImplementation

init

shutdown

getTunesExecutor

getAudioMetaDataExecutor

serialExecute

serialExecute

smuggle

getLock

lock

getTunes

isNewDatabase

setNewDatabase

countSongs

countSongsWithPropertyValue

getSongsWithPropertyValue

getSongIdsWithPropertyValue

getSongsWithoutPropertyValue

getSongIdsWithoutPropertyValue

getSongsWithPropertyLikeValue

getSongIdsWithPropertyLikeValue

getSongs

getSongs

getSongIds

getSongIds

getSong

fetchCollections

getGenres

getSongPropertyValues

getSongPropertyValues

getSongPropertyValues

getDuplicateTitles

getDuplicateTrackIds

getAcousticallyIdenticalSongIds

getAcousticallyIdenticalSongIds

getSimilarTitles

getLibrary

getPlayLists

getPlayList

createPlayList

createPlayList

createFolder

createFolder

createPlayList

getAlbum

getAlbumSongIds

getAlbumSongs

getAlbumKeys

getRecentlyPlayedAlbums

getHighlyRatedAlbums

getAllTimesFavoriteAlbums

getRecentlyAddedAlbums

getSongsWithFileAndSize

getSongsWithNameArtistAlbumTotalTime

getSongsWithTrackIdTotalTime

countUnprotectedSongsAddedAfter

getUnprotectedSongsAddedAfter

getPopularTagCollection

getTagCollection

store

store

store

store

flushPendingWrites

deletePlayList

getLastSynchronizationTimestamp

getPreviousToLastSynchronizationTimestamp

setLibraryDescriptor

getLibraryDescriptor

getApplicationVersion

getPersistentId

refresh

refresh

needsRefresh

isOneWeekOld

addITunesMusicLibraryListener

store