Playlist

java.lang.Object
- snow.player.playlist.Playlist

所有已实现的接口:

android.os.Parcelable, java.lang.Iterable<MusicItem>
```
public final class Playlist
extends java.lang.Object
implements java.lang.Iterable<MusicItem>, android.os.Parcelable
```
用于存储播放队列。
Playlist 对象是不可变的，且不包含重复的 MusicItem 对象，并且最大尺寸为 MAX_SIZE（1000）。如果往 Playlist 中添加的 MusicItem 数量超出了最大尺寸，则超出部分会被忽略。
关于 Playlist 的 “可编辑” 状态，在这里对其进行说明。在创建 Playlist 对象时，你可能已经注意到构造器有一个 editable 参数，但 Playlist 本身是不可变的，它并未提供任何编辑方法，你可能会对此存在疑惑。
实际上，Playlist 的 “可编辑” 状态是针对播放器而言的。如果 Playlist 是不可编辑的，则所有通过 PlayerClient 修改播放列表的操作会被忽略。
也就是说，如果 Playlist 是不可编辑，则调用 PlayerClient 的以下方法时会被忽略：
另请参阅:

PlayerClient.setPlaylist(Playlist, int, boolean)

嵌套类概要

嵌套类
限定符和类型类和说明

static class Playlist.Builder
Playlist 构建器。
- 从接口继承的嵌套类/接口 android.os.Parcelable
  android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

嵌套类
限定符和类型	类和说明
`static class`	`Playlist.Builder` `Playlist` 构建器。

字段概要

字段
限定符和类型字段和说明

static android.os.Parcelable.Creator<Playlist> CREATOR

static int MAX_SIZE
- 从接口继承的字段 android.os.Parcelable
  CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

字段
限定符和类型	字段和说明
`static android.os.Parcelable.Creator<Playlist>`	`CREATOR`
`static int`	`MAX_SIZE`

构造器概要

构造器
限定符	构造器和说明
`protected`	`Playlist(android.os.Parcel in)`
	`Playlist(java.lang.String name, java.util.List<MusicItem> items, boolean editable, android.os.Bundle extra)` 创建一个 `Playlist` 对象。
	`Playlist(java.lang.String name, java.util.List<MusicItem> items, int position, boolean editable, android.os.Bundle extra)` 创建一个 `Playlist` 对象。

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`contains(MusicItem musicItem)` 如果当前播放队列包含指定的元素，则返回 true。
`int`	`describeContents()`
`boolean`	`equals(java.lang.Object obj)` 不包含携带的 `extra` 数据
`MusicItem`	`get(int index)` 返回当前播放队列中指定位置的元素。
`java.util.List<MusicItem>`	`getAllMusicItem()` 获取当前播放队列中包含的所有 MusicItem 元素。
`android.os.Bundle`	`getExtra()`
`java.lang.String`	`getName()` 获取播放列表的名称。
`java.lang.String`	`getToken()` 获取播放列表的 Token。
`int`	`hashCode()` 不包含携带的 `extra` 数据
`int`	`indexOf(MusicItem musicItem)` 返回当前播放队列中第一次出现的指定元素的索引；如果当前播放队列不包含该元素，则返回 -1。
`boolean`	`isEditable()` 播放列表是否是可编辑的。
`boolean`	`isEmpty()` 如果当前播放队列在没有任何元素，则返回 true。
`java.util.Iterator<MusicItem>`	`iterator()` 返回按适当顺序在当前播放队列的元素上进行迭代的迭代器。
`int`	`size()` 返回当前播放队列中的元素数。
`void`	`writeToParcel(android.os.Parcel dest, int flags)`

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 java.lang.Iterable
forEach, spliterator

- 字段详细资料
  - MAX_SIZE
```
public static final int MAX_SIZE
```
    另请参阅:
    
    常量字段值
  - CREATOR
```
public static final android.os.Parcelable.Creator<Playlist> CREATOR
```
- 构造器详细资料
  - Playlist
```
public Playlist(@NonNull
                java.lang.String name,
                @NonNull
                java.util.List<MusicItem> items,
                boolean editable,
                @Nullable
                android.os.Bundle extra)
```
    创建一个 Playlist 对象。
    注意！如果 items 列表的尺寸大于 MAX_SIZE，超出部分会被丢弃。
    
    参数:
    
    name - 播放列表的名称，不能为 null
    
    items - 所由要添加到播放列表的中的 MusicItem 对象，超出 MAX_SIZE（1000）的部分元素会被忽略
    
    editable - 播放列表是否是可编辑的
    
    extra - 播放列表的额外参数
  - Playlist
```
public Playlist(@NonNull
                java.lang.String name,
                @NonNull
                java.util.List<MusicItem> items,
                int position,
                boolean editable,
                @Nullable
                android.os.Bundle extra)
```
    创建一个 Playlist 对象。
    注意！如果 items 列表的尺寸大于 MAX_SIZE，则会以 position 参数作为基准索引，先向后提取 MusicItem 元素，当 position 后面的元素数不足以凑足 MAX_SIZE 时，再从 position 处向前提取，直至凑足 MAX_SIZE 个 MusicItem 元素。然后再使用这 MAX_SIZE 个 MusicItem 元素来创建 Playlist 对象。
    
    参数:
    
    name - 播放列表的名称，不能为 null
    
    items - 所由要添加到播放列表的中的 MusicItem 对象，重复的元素会被排除。当列表尺寸大于 MAX_SIZE 时，会以 position 参数作为基准来提取一个大小为 MAX_SIZE 的子列表。
    
    position - 基准索引，仅在 items 列表的尺寸大于 MAX_SIZE 时有用
    
    editable - 播放列表是否是可编辑的
    
    extra - 播放列表的额外参数
  - Playlist
```
protected Playlist(android.os.Parcel in)
```
- 方法详细资料
  - getName
```
@NonNull
public java.lang.String getName()
```
    获取播放列表的名称。
    
    返回:
    
    播放列表的名称，不为 null
  - getToken
```
@NonNull
public java.lang.String getToken()
```
    获取播放列表的 Token。
    
    返回:
    
    播放列表的 Token。一个全部小写的 SHA-256 摘要字符串，由 Playlist 根据其包含的所有歌曲的 URI 自动生成。
    
    另请参阅:
    
    MusicItem.getUri(), MusicItemUtil.generateToken(List, MusicItemUtil.GetUriFunction)
  - isEditable
```
public boolean isEditable()
```
    播放列表是否是可编辑的。
    Playlist 本身是不可变的，这里的 “可编辑” 状态是针对播放器而言的。如果 Playlist 是不可编辑的，则所有通过 PlayerClient 修改播放列表的操作会被忽略。
    也就是说，如果 Playlist 是不可编辑，则 PlayerClient 的以下方法会被忽略：
    返回:
    
    播放列表是否是可编辑的，如果是可编辑的，则返回 true，否则返回 false（默认为 true）。
  - contains
```
public boolean contains(MusicItem musicItem)
```
    如果当前播放队列包含指定的元素，则返回 true。
  - get
```
public MusicItem get(int index)
              throws java.lang.IndexOutOfBoundsException
```
    返回当前播放队列中指定位置的元素。
    
    参数:
    
    index - 要返回的元素的索引。
    
    返回:
    
    当前播放队列中指定位置的元素。
    
    抛出:
    
    java.lang.IndexOutOfBoundsException - 如果索引超出范围 (index < 0 || index >= size())
  - indexOf
```
public int indexOf(@NonNull
                   MusicItem musicItem)
```
    返回当前播放队列中第一次出现的指定元素的索引；如果当前播放队列不包含该元素，则返回 -1。
    
    参数:
    
    musicItem - 要搜索的元素（不能为 null）
    
    返回:
    
    此当前播放队列中第一次出现的指定元素的索引，如果当前播放队列不包含该元素，则返回 -1
  - isEmpty
```
public boolean isEmpty()
```
    如果当前播放队列在没有任何元素，则返回 true。
    
    返回:
    
    如果列表不包含元素，则返回 true。
  - iterator
```
@NonNull
public java.util.Iterator<MusicItem> iterator()
```
    返回按适当顺序在当前播放队列的元素上进行迭代的迭代器。
    注意！由于 Playlist 被设计为是不可变的，因此不允许使用 Iterator#remove() 方法来删除元素。
    
    指定者:
    
    iterator 在接口中 java.lang.Iterable<MusicItem>
    
    返回:
    
    按适当顺序在列表的元素上进行迭代的迭代器。
  - size
```
public int size()
```
    返回当前播放队列中的元素数。
    如果当前播放队列包含多于 Integer.MAX_VALUE 个元素，则返回 Integer.MAX_VALUE。
    
    返回:
    
    当前播放队列中的元素数
  - getAllMusicItem
```
public java.util.List<MusicItem> getAllMusicItem()
```
    获取当前播放队列中包含的所有 MusicItem 元素。
    如果当前播放队列为空，则返回一个空列表。
    
    返回:
    
    当前播放队列中包含的所有 MusicItem 元素。如果当前播放队列为空，则返回一个空列表。
  - getExtra
```
@Nullable
public android.os.Bundle getExtra()
```
  - equals
```
public boolean equals(@Nullable
                      java.lang.Object obj)
```
    不包含携带的 extra 数据
    
    覆盖:
    
    equals 在类中 java.lang.Object
  - hashCode
```
public int hashCode()
```
    不包含携带的 extra 数据
    
    覆盖:
    
    hashCode 在类中 java.lang.Object
  - writeToParcel
```
public void writeToParcel(android.os.Parcel dest,
                          int flags)
```
    指定者:
    
    writeToParcel 在接口中 android.os.Parcelable
  - describeContents
```
public int describeContents()
```
    指定者:
    
    describeContents 在接口中 android.os.Parcelable

类 Playlist

嵌套类概要

从接口继承的嵌套类/接口 android.os.Parcelable

字段概要

从接口继承的字段 android.os.Parcelable

构造器概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 java.lang.Iterable

字段详细资料

MAX_SIZE

CREATOR

构造器详细资料

Playlist

Playlist

Playlist

方法详细资料

getName

getToken

isEditable

contains

get

indexOf

isEmpty

iterator

size

getAllMusicItem

getExtra

equals

hashCode

writeToParcel

describeContents