com.docomostar.ui.avplayer
クラス FilteringElement

Object
  com.docomostar.ui.avplayer.FilteringElement

public final class FilteringElement
extends Object

[iアプリオプションAPI]

フィルタリングするための検索条件を保持するクラスです。 Filterable インタフェースで定義されているフィルタリングメソッドにおける、 検索条件を保持するクラスです。

このクラスのインスタンスが保持している、フィルタリング結果タイプ、 検索対象、検索文字列の意味については、Filterable インタフェースの説明を参照してください。
原則として、以下の2つのメソッド呼び出しの結果は同一となります。

• このクラスのインスタンスを引数に指定して、 Filterable.filter(FilteringElement) を呼び出す場合
• このクラスのインスタンスが保持しているフィルタリング結果タイプ、検索対象、 検索文字列を引数に指定して、 Filterable.filter(int, int, String) を呼び出す場合

導入されたバージョン:

Star-1.5

関連項目:

Filterable, Filterable.filter(FilteringElement), FilteringResult.getFilteringElements()

コンストラクタの概要

FilteringElement(int resultType, int target, String str)
コンストラクタです。

メソッドの概要

int	getResultType() このインスタンスが保持しているフィルタリング結果タイプを取得します。
String	getString() このインスタンスが保持している検索文字列を取得します。
int	getTargetType() このインスタンスが保持している検索対象を取得します。

クラス Object から継承されたメソッド

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

FilteringElement

public FilteringElement(int resultType,
                        int target,
                        String str)

コンストラクタです。

引数の詳細は、Filterable インタフェースを参照して下さい。

パラメータ:

resultType - フィルタリング結果タイプを指定します。

target - 検索対象を指定します。

str - 検索文字列を指定します。

関連項目:

Filterable.TYPE_ARTIST, Filterable.TYPE_ALBUM, Filterable.TYPE_GENRE, Filterable.TYPE_CONTENT

例外:

UnsupportedOperationException -
音楽プレイヤー機能をサポートしていない場合に発生します。

IllegalArgumentException -
引数 resultType が不正な場合に発生します。

IllegalArgumentException -
引数 target が不正な場合に発生します。

メソッドの詳細

getResultType

public int getResultType()

このインスタンスが保持しているフィルタリング結果タイプを取得します。

このインスタンス生成時にコンストラクタの引数で指定されたフィルタリング結果タイプと同じ値を返します。

戻り値:

このインスタンスが保持しているフィルタリング結果タイプを返します。

関連項目:

Filterable.TYPE_ARTIST, Filterable.TYPE_ALBUM, Filterable.TYPE_GENRE, Filterable.TYPE_CONTENT

getTargetType

public int getTargetType()

このインスタンスが保持している検索対象を取得します。

このインスタンス生成時にコンストラクタの引数で指定された検索対象と同じ値を返します。

戻り値:

このインスタンスが保持している検索対象を返します。

関連項目:

Filterable.TYPE_ARTIST, Filterable.TYPE_ALBUM, Filterable.TYPE_GENRE

getString

public String getString()

このインスタンスが保持している検索文字列を取得します。

このインスタンス生成時にコンストラクタの引数で指定された検索文字列と同じ値を返します。

戻り値:

このインスタンスが保持している検索文字列を返します。