PlayList (beaTunes 4.6.16 API)

All Superinterfaces:

ListModel, Serializable

All Known Implementing Classes:

FileSystemPlayList, HibernatePlayList, ITunesPlayList, PlayListFacade
```
public interface PlayList
extends Serializable, ListModel
```
PlayList.
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 ITunesMusicLibrary.store(com.tagtraum.audiokern.AudioSong, String) - changes are persisted automatically in the internal database, iTunes (or whatever other audioplayer) as well as the file.

Author:

Hendrik Schreiber

See Also:

ITunesMusicLibrary

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`PlayList.Kind` Kinds of playlists.
`static class`	`PlayList.SortDirection`
`static class`	`PlayList.SubstringFilterProperty` SubstringFilterProperty.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(PropertyChangeListener propertyChangeListener)`
`void`	`addPropertyChangeListener(String property, PropertyChangeListener propertyChangeListener)`
`void`	`addSongIds(int filteredIndex, List<Long> songIds)` Adds the given songs at the given (filtered) index.
`void`	`addSongIds(List<Long> songIds)`
`void`	`addSongs(int filteredIndex, List<AudioSong> songs)` Adds the given songs at the given (filtered) index.
`void`	`addSongs(int filteredIndex, String... locations)` Adds songs to the playlist using only their locations. Depending on the library implementation, the insert index may be ignored.
`boolean`	`canAddItem()` Indicates whether we can add items to this playlist.
`boolean`	`canInsertItem()` Indicates whether we can insert items into this playlist.
`default boolean`	`contains(AudioSong song)`
`boolean`	`contains(Long id)`
`int`	`countSongs(Collection<? extends SongFilter> filters)`
`int`	`countSongs(SongFilter filter)`
`int[]`	`filteredIndices(int... unfilteredIndices)` Returns the filtered indices (string, order) for the given unfiltered indices.
`PlayListIterator<AudioSong>`	`filteredListIterator(int startIndex)` Creates a dynamically updated iterator for this playlist.
`List<PlayList>`	`getChildPlayLists()`
`PlayList.Kind`	`getDistinguishedKind()`
`long`	`getFileSize()` Get the sum of all file sizes (with filters applied).
`List<Long>`	`getFilteredSongIds()` Returns song ids from this playlist, both sorted and filtered.
`Iterable<AudioSong>`	`getFilteredSongs()` Returns songs from this playlist, both sorted and filtered.
`int`	`getGeniusTrackID()`
`Long`	`getId()`
`Long`	`getIdAt(int index)` Returns id of the song at the given index, taking sorting and filtering into account.
`<T> T`	`getImplementation(Class<T> klass)`
`IndexedId[]`	`getIndexedSongIds()` A complete list of sorted ids along with their natural order indices (via `IndexedId.getIndex()`).
`MatchListInfo`	`getMatchListInfo()`
`Long`	`getMatchListInfoId()`
`String`	`getName()`
`Long`	`getParentId()`
`PlayList`	`getParentPlayList()`
`PlayList[]`	`getPlayListPath()` Returns path leading to this playlist and ending with it.
`String`	`getSmartCriteria()`
`String`	`getSmartInfo()`
`AudioSong`	`getSong(int index)` Returns song from the given index, taking sorting and filtering into account.
`List<Long>`	`getSongIds()` Returns song ids from this playlist, neither sorted not filtered.
`List<Long>`	`getSongIds(Set<? extends SongFilter> filters)` Returns song ids from this playlist, filtered with the given filters.
`Iterable<AudioSong>`	`getSongs()` Returns songs from this playlist, neither sorted not filtered.
`List<AudioSong>`	`getSongs(Collection<? extends SongFilter> filters, int limit)` Returns songs from this playlist, filtered with the given filters.
`Iterable<AudioSong>`	`getSongs(String sortProperty)` Returns songs from this playlist, sorted by the given property.
`String`	`getSortColumnProperty()` Returns the name of the single property the playlist is sorted by.
`PlayList.SortDirection`	`getSortDirection()` Return sort direction.
`String[]`	`getSortProperties()` Actual sort properties, used in `ORDER BY` SQL clauses.
`String`	`getSortProperty(int index)` Actual sort property, used in `ORDER BY` SQL clauses.
`String`	`getSubstringFilter()`
`PlayList.SubstringFilterProperty`	`getSubstringFilterProperty()`
`long`	`getTotalTime()` Get time with filters applied.
`int`	`getUnfilteredSize()` Unfiltered number of songs in playlist.
`long`	`getUnfilteredTime()` Get time without any filters applied.
`default int`	`indexOf(AudioSong song)` Returns the first index of the given song.
`int`	`indexOf(Long id)` Returns the first index of the given song.
`boolean`	`isAggregateDataAvailable()` Indicates whether this we currently have valid aggregate (total size, duration, etc.) data.
`boolean`	`isAllItems()`
`boolean`	`isAudiobooks()`
`boolean`	`isEditable()` Is this playlist editable? Only playlists created by users are editable.
`boolean`	`isFolder()`
`boolean`	`isGeniusPlaylist()`
`boolean`	`isLibrary()` Indicates that this is a library playlist, meaning one of the top level library views (e.g.
`boolean`	`isMaster()` Indicates whether this playlist is a master playlist.
`boolean`	`isMatchList()`
`boolean`	`isMovies()`
`boolean`	`isMusic()`
`boolean`	`isParentAFolder()`
`boolean`	`isPartyShuffle()` Deprecated.
`boolean`	`isPodcasts()`
`boolean`	`isPurchasedMusic()`
`boolean`	`isSmartPlaylist()`
`boolean`	`isTvShows()`
`boolean`	`isUserPlaylist()` Indicates that the playlist is just a regular user playlist.
`boolean`	`isVideos()` Deprecated.
`int`	`moveSongs(int[] fromIndices, int toIndex)` Moves songs.
`void`	`removePropertyChangeListener(PropertyChangeListener propertyChangeListener)`
`boolean`	`removeSongs(Collection<Long> ids)` Removes the songs with the given ids from the list.
`boolean`	`removeSongs(int... filteredIndex)` Removes the song with the given (filtered) index from the playlist.
`void`	`setAllItems(boolean allItems)`
`void`	`setAudiobooks(boolean audiobooks)`
`void`	`setChildPlayLists(List<PlayList> childPlayLists)`
`void`	`setDistinguishedKind(PlayList.Kind distinguishedKind)`
`void`	`setFolder(boolean folder)`
`void`	`setGeniusTrackID(int geniusTrackID)`
`void`	`setId(Long id)`
`void`	`setMaster(boolean master)`
`void`	`setMatchListInfo(MatchListInfo matchListInfo)`
`void`	`setMovies(boolean movies)`
`void`	`setMusic(boolean music)`
`void`	`setName(String name)`
`void`	`setParentId(Long parentId)`
`void`	`setParentPlayList(PlayList parentPlayList)`
`void`	`setPartyShuffle(boolean partyShuffle)` Deprecated.
`void`	`setPodcasts(boolean podcasts)`
`void`	`setPurchasedMusic(boolean purchasedMusic)`
`void`	`setSmartCriteria(String smartCriteria)`
`void`	`setSmartInfo(String smartInfo)`
`void`	`setSongs(List<AudioSong> songs)`
`void`	`setSortColumnProperty(String property)` Sets "visual/semantic" sort property.
`void`	`setSortDirection(PlayList.SortDirection sortDirection)` Sort direction.
`void`	`setSortProperties(String... properties)` Sets sort properties.
`void`	`setSubstringFilter(String substring, PlayList.SubstringFilterProperty substringFilterProperty)`
`void`	`setTvShows(boolean tvShows)`
`void`	`setVideos(boolean videos)` Deprecated.
`int[]`	`unfilteredIndices(int... filteredIndices)` Returns the unfiltered indices for the given filtered (string, order) indices.

Methods inherited from interface javax.swing.ListModel
addListDataListener, getElementAt, getSize, removeListDataListener

- Method Detail
  - getImplementation
```
<T> T getImplementation(Class<T> klass)
```
  - removePropertyChangeListener
```
void removePropertyChangeListener(PropertyChangeListener propertyChangeListener)
```
  - addPropertyChangeListener
```
void addPropertyChangeListener(PropertyChangeListener propertyChangeListener)
```
  - addPropertyChangeListener
```
void addPropertyChangeListener(String property,
                               PropertyChangeListener propertyChangeListener)
```
  - getId
```
Long getId()
```
  - setId
```
void setId(Long id)
```
  - getParentId
```
Long getParentId()
```
  - setParentId
```
void setParentId(Long parentId)
```
  - getMatchListInfo
```
MatchListInfo getMatchListInfo()
```
  - getMatchListInfoId
```
Long getMatchListInfoId()
```
  - setMatchListInfo
```
void setMatchListInfo(MatchListInfo matchListInfo)
```
  - isMatchList
```
boolean isMatchList()
```
  - getDistinguishedKind
```
PlayList.Kind getDistinguishedKind()
```
  - setDistinguishedKind
```
void setDistinguishedKind(PlayList.Kind distinguishedKind)
```
  - isAudiobooks
```
boolean isAudiobooks()
```
  - setAudiobooks
```
void setAudiobooks(boolean audiobooks)
```
  - isMovies
```
boolean isMovies()
```
  - setMovies
```
void setMovies(boolean movies)
```
  - isMusic
```
boolean isMusic()
```
  - setMusic
```
void setMusic(boolean music)
```
  - isTvShows
```
boolean isTvShows()
```
  - setTvShows
```
void setTvShows(boolean tvShows)
```
  - isPartyShuffle
```
@Deprecated
boolean isPartyShuffle()
```
    Deprecated.
  - setPartyShuffle
```
@Deprecated
void setPartyShuffle(boolean partyShuffle)
```
    Deprecated.
  - isPodcasts
```
boolean isPodcasts()
```
  - setPodcasts
```
void setPodcasts(boolean podcasts)
```
  - getChildPlayLists
```
List<PlayList> getChildPlayLists()
```
  - setChildPlayLists
```
void setChildPlayLists(List<PlayList> childPlayLists)
```
  - getParentPlayList
```
PlayList getParentPlayList()
```
  - setParentPlayList
```
void setParentPlayList(PlayList parentPlayList)
```
  - getPlayListPath
```
PlayList[] getPlayListPath()
```
    Returns path leading to this playlist and ending with it. I.e., the path has at least the length 1.
    
    Returns:
    
    path of playlists
  - getName
```
String getName()
```
  - setName
```
void setName(String name)
```
  - isMaster
```
boolean isMaster()
```
    Indicates whether this playlist is a master playlist. E.g. the (invisible list) Library is typically the master playlist.
    
    Returns:
    
    true or false
    
    See Also:
    
    isLibrary()
  - setMaster
```
void setMaster(boolean master)
```
  - isLibrary
```
boolean isLibrary()
```
    Indicates that this is a library playlist, meaning one of the top level library views (e.g. Music, AudioBooks, etc.).
    
    Returns:
    
    true or false
    
    See Also:
    
    isMaster()
  - getGeniusTrackID
```
int getGeniusTrackID()
```
  - setGeniusTrackID
```
void setGeniusTrackID(int geniusTrackID)
```
  - isGeniusPlaylist
```
boolean isGeniusPlaylist()
```
  - isAllItems
```
boolean isAllItems()
```
  - setAllItems
```
void setAllItems(boolean allItems)
```
  - getSmartInfo
```
String getSmartInfo()
```
  - setSmartInfo
```
void setSmartInfo(String smartInfo)
```
  - isSmartPlaylist
```
boolean isSmartPlaylist()
```
  - getSmartCriteria
```
String getSmartCriteria()
```
  - setSmartCriteria
```
void setSmartCriteria(String smartCriteria)
```
  - isVideos
```
@Deprecated
boolean isVideos()
```
    Deprecated.
    
    iTunes 6 playlist attribute.
    
    Returns:
    
    true or false
  - setVideos
```
@Deprecated
void setVideos(boolean videos)
```
    Deprecated.
  - getFilteredSongIds
```
List<Long> getFilteredSongIds()
```
    Returns song ids from this playlist, both sorted and filtered.
    
    Returns:
    
    song ids
  - getSongIds
```
List<Long> getSongIds()
```
    Returns song ids from this playlist, neither sorted not filtered.
    
    Returns:
    
    song ids
  - getIndexedSongIds
```
IndexedId[] getIndexedSongIds()
```
    A complete list of sorted ids along with their natural order indices (via IndexedId.getIndex()). Natural indices of filtered out objects are flipped: -(index+1)
    
    Returns:
    
    a complete list of persistent ids along with their natural indices
  - getSongIds
```
List<Long> getSongIds(Set<? extends SongFilter> filters)
```
    Returns song ids from this playlist, filtered with the given filters.
    
    Returns:
    
    song ids
  - getSongs
```
Iterable<AudioSong> getSongs()
```
    Returns songs from this playlist, neither sorted not filtered.
    
    Returns:
    
    songs
  - getSongs
```
Iterable<AudioSong> getSongs(String sortProperty)
```
    Returns songs from this playlist, sorted by the given property.
    
    Parameters:
    
    sortProperty - property
    
    Returns:
    
    songs
  - getSongs
```
List<AudioSong> getSongs(Collection<? extends SongFilter> filters,
                         int limit)
```
    Returns songs from this playlist, filtered with the given filters.
    
    Parameters:
    
    filters - filters
    
    limit - limit, -1 for no limit
    
    Returns:
    
    songs
  - getFilteredSongs
```
Iterable<AudioSong> getFilteredSongs()
```
    Returns songs from this playlist, both sorted and filtered.
    
    Returns:
    
    songs
  - filteredListIterator
```
PlayListIterator<AudioSong> filteredListIterator(int startIndex)
```
    Creates a dynamically updated iterator for this playlist. This iterator will adjust to sort/filter changes to the underlying playlist.
    The iterator does not support mutable operations.
    
    Parameters:
    
    startIndex - index to start iterating from, first call to ListIterator.next() or ListIterator.previous() will produce the song at the given index
    
    Returns:
    
    read-only, dynamically adjusting list iterator
  - countSongs
```
int countSongs(SongFilter filter)
```
  - countSongs
```
int countSongs(Collection<? extends SongFilter> filters)
```
  - setSongs
```
void setSongs(List<AudioSong> songs)
```
  - addSongIds
```
void addSongIds(List<Long> songIds)
```
  - addSongs
```
void addSongs(int filteredIndex,
              String... locations)
```
    Adds songs to the playlist using only their locations.
    Depending on the library implementation, the insert index may be ignored. If it is ignored, the songs will be appended at the end (this is the case for iTunes libraries).
    
    Parameters:
    
    filteredIndex - filtered index, set this to -1, if you just want to add the song to the end
    
    locations - file or URL
    
    See Also:
    
    AudioSongLocation.getLocation()
  - addSongs
```
void addSongs(int filteredIndex,
              List<AudioSong> songs)
```
    Adds the given songs at the given (filtered) index.
    
    Parameters:
    
    filteredIndex - filtered index
    
    songs - songs
  - addSongIds
```
void addSongIds(int filteredIndex,
                List<Long> songIds)
```
    Adds the given songs at the given (filtered) index.
    
    Parameters:
    
    filteredIndex - filtered index
    
    songIds - songs
  - moveSongs
```
int moveSongs(int[] fromIndices,
              int toIndex)
```
    Moves songs. All indices have to be filtered.
    
    Parameters:
    
    fromIndices - indices to move songs from
    
    toIndex - index to move the songs to
    
    Returns:
    
    new lead index of the moved songs
  - getUnfilteredSize
```
int getUnfilteredSize()
```
    Unfiltered number of songs in playlist. May return -1, if the number is unknown
    
    Returns:
    
    number of songs in playlist
    
    See Also:
    
    setSubstringFilter(String, com.tagtraum.beatunes.library.PlayList.SubstringFilterProperty)
  - unfilteredIndices
```
int[] unfilteredIndices(int... filteredIndices)
```
    Returns the unfiltered indices for the given filtered (string, order) indices.
    
    Parameters:
    
    filteredIndices - filtered indices
    
    Returns:
    
    unfiltered equivalents
  - filteredIndices
```
int[] filteredIndices(int... unfilteredIndices)
```
    Returns the filtered indices (string, order) for the given unfiltered indices.
    
    Parameters:
    
    unfilteredIndices - unfiltered indices
    
    Returns:
    
    filtered equivalents or -1, if that does not exist, because the index was filtered out
  - indexOf
```
int indexOf(Long id)
```
    Returns the first index of the given song.
    
    Parameters:
    
    id - song id
    
    Returns:
    
    index or -1, if not found
  - indexOf
```
default int indexOf(AudioSong song)
```
    Returns the first index of the given song.
    
    Parameters:
    
    song - song
    
    Returns:
    
    index or -1, if not found
  - removeSongs
```
boolean removeSongs(int... filteredIndex)
```
    Removes the song with the given (filtered) index from the playlist. If this is a library, the file is also deleted.
    
    Parameters:
    
    filteredIndex - filtered indices
    
    Returns:
    
    true, if the system was able to find and remove the given song
  - removeSongs
```
boolean removeSongs(Collection<Long> ids)
```
    Removes the songs with the given ids from the list. If this is the library, the songs are also deleted.
    
    Parameters:
    
    ids - ids
    
    Returns:
    
    success
  - getSong
```
AudioSong getSong(int index)
```
    Returns song from the given index, taking sorting and filtering into account. This method may return null even if a corresponding song, because it is loaded asynchronously.
    Use getIdAt(int), if you need a synchronous result.
    
    Parameters:
    
    index - index
    
    Returns:
    
    song or null, if not in the cache or the index is bad
    
    See Also:
    
    getIdAt(int)
  - getIdAt
```
Long getIdAt(int index)
```
    Returns id of the song at the given index, taking sorting and filtering into account. Other than getSong(int), this method always returns an id, if the index is valid.
    
    Parameters:
    
    index - index
    
    Returns:
    
    id or null, if the index it not valid
    
    See Also:
    
    getSong(int)
  - contains
```
boolean contains(Long id)
```
  - contains
```
default boolean contains(AudioSong song)
```
  - isFolder
```
boolean isFolder()
```
  - isParentAFolder
```
boolean isParentAFolder()
```
  - setFolder
```
void setFolder(boolean folder)
```
  - isUserPlaylist
```
boolean isUserPlaylist()
```
    Indicates that the playlist is just a regular user playlist. Note that Matchlists are not considered regular user playlists.
    
    Returns:
    
    true or false.
  - isPurchasedMusic
```
boolean isPurchasedMusic()
```
  - setPurchasedMusic
```
void setPurchasedMusic(boolean purchasedMusic)
```
  - canInsertItem
```
boolean canInsertItem()
```
    Indicates whether we can insert items into this playlist.
    
    Returns:
    
    true or false, typically false for generated lists like "Music"
  - canAddItem
```
boolean canAddItem()
```
    Indicates whether we can add items to this playlist.
    
    Returns:
    
    true or false, typically false for generated lists like "Music"
  - isEditable
```
boolean isEditable()
```
    Is this playlist editable? Only playlists created by users are editable.
    
    Returns:
    
    true or false
  - getTotalTime
```
long getTotalTime()
```
    Get time with filters applied.
    
    Returns:
    
    time
  - getUnfilteredTime
```
long getUnfilteredTime()
```
    Get time without any filters applied.
    
    Returns:
    
    time
  - getFileSize
```
long getFileSize()
```
    Get the sum of all file sizes (with filters applied).
    
    Returns:
    
    sum of file sizes
  - isAggregateDataAvailable
```
boolean isAggregateDataAvailable()
```
    Indicates whether this we currently have valid aggregate (total size, duration, etc.) data. If the data is not available, the asynchronous computation is triggered.
    
    Returns:
    
    true or false
  - getSortColumnProperty
```
String getSortColumnProperty()
```
    Returns the name of the single property the playlist is sorted by. Note that for special properties like name this may not be the same properties as the ones we use for ORDER BY SQL clauses. But, it's the property that should be highlighted in a UI.
    
    Returns:
    
    column
  - setSortColumnProperty
```
void setSortColumnProperty(String property)
```
    Sets "visual/semantic" sort property.
    
    Parameters:
    
    property - name of the property that is marked as sorted-by in the UI
    
    See Also:
    
    getSortColumnProperty()
  - getSortProperty
```
String getSortProperty(int index)
```
    Actual sort property, used in ORDER BY SQL clauses.
    
    Parameters:
    
    index - index
    
    Returns:
    
    property or null
  - getSortProperties
```
String[] getSortProperties()
```
    Actual sort properties, used in ORDER BY SQL clauses.
    
    Returns:
    
    sort properties
  - setSortProperties
```
void setSortProperties(String... properties)
```
    Sets sort properties.
    
    Parameters:
    
    properties - sort properties
  - setSortDirection
```
void setSortDirection(PlayList.SortDirection sortDirection)
```
    Sort direction.
    
    Parameters:
    
    sortDirection - sort direction
  - getSortDirection
```
PlayList.SortDirection getSortDirection()
```
    Return sort direction.
    
    Returns:
    
    sort direction
  - getSubstringFilter
```
String getSubstringFilter()
```
  - setSubstringFilter
```
void setSubstringFilter(String substring,
                        PlayList.SubstringFilterProperty substringFilterProperty)
```
  - getSubstringFilterProperty
```
PlayList.SubstringFilterProperty getSubstringFilterProperty()
```

Interface PlayList

Nested Class Summary

Method Summary

Methods inherited from interface javax.swing.ListModel

Method Detail

getImplementation

removePropertyChangeListener

addPropertyChangeListener

addPropertyChangeListener

getId

setId

getParentId

setParentId

getMatchListInfo

getMatchListInfoId

setMatchListInfo

isMatchList

getDistinguishedKind

setDistinguishedKind

isAudiobooks

setAudiobooks

isMovies

setMovies

isMusic

setMusic

isTvShows

setTvShows

isPartyShuffle

setPartyShuffle

isPodcasts

setPodcasts

getChildPlayLists

setChildPlayLists

getParentPlayList

setParentPlayList

getPlayListPath

getName

setName

isMaster

setMaster

isLibrary

getGeniusTrackID

setGeniusTrackID

isGeniusPlaylist

isAllItems

setAllItems

getSmartInfo

setSmartInfo

isSmartPlaylist

getSmartCriteria

setSmartCriteria

isVideos

setVideos

getFilteredSongIds

getSongIds

getIndexedSongIds

getSongIds

getSongs

getSongs

getSongs

getFilteredSongs

filteredListIterator

countSongs

countSongs

setSongs

addSongIds

addSongs

addSongs

addSongIds

moveSongs

getUnfilteredSize

unfilteredIndices

filteredIndices

indexOf

indexOf

removeSongs

removeSongs

getSong

getIdAt

contains