Result
パッケージ
com.nttqonoq.devices.android.mirzalibrary
クラス Result<T>
継承ツリー
Object
com.nttqonoq.devices.android.mirzalibrary.Result<T>
クラスの説明
public class Result<T>
extends Object
連携結果を表すクラス
このクラスは、MiRZAアプリとの連携結果の状態、関連データを含むジェネリッククラスです。
ネストされたクラスの概要
ネストされたクラス
| 修飾子とタイプ | クラス | 説明 |
|---|---|---|
| static enum | Result.State | 結果の状態を表すEnum |
コンストラクタの概要
コンストラクタ
| コンストラクタ | 説明 |
|---|---|
| Result(Result.State state) | 指定された状態で新しいResultを生成する |
| Result(Result.State state, T data) | 指定された状態、関連データで新しいResultを生成する |
| Result(Result.State state, T data, String errorMessage) | 指定され た状態、関連データおよびエラーメッセージで新しいResultを生成する |
メソッドの概要
すべてのメソッド
| 修飾子とタイプ | メソッド | 説明 |
|---|---|---|
| T | getData() | 結果に関連するデータを返す |
| String | getErrorMessage() | エラーメッセージを返す |
| Result.State | getState() | 結果の状態を返す |
| static <T> Result<T> | glassNotConnected() | グラスデバイス未接続の結果を生成する |
| static <T> Result<T> | glassNotConnectedOrTimeout() | グラスデバイス未接続またはタイムアウトの結果を生成する |
| static <T> Result<T> | glassNotPaired() | グラスデバイス未ペアリングの結果を生成する |
| boolean | isSuccess() | 連携結果の状態が成功しているかを判断する |
| static <T> Result<T> | mirzaAppInNotSpacesMode() | MiRZAアプリ側が MRモードになっていないという結果を生成する |
| static <T> Result<T> | notFoundMirzaApp() | MiRZAアプリが見つからない結果を生成する |
| static <T> Result<T> | serviceError(String errorMessage) | サービスエラーの結果を生成する |
| static <T> Result<T> | serviceNotConnected() | サービス未接続の結果を生成する |
| static <T> Result<T> | success(String message) | 成功した結果を生成する |
| static <T> Result<T> | success(T data) | 成功した結果を生成する |
| static <T> Result<T> | unexpectedResponseData(String errorMessage) | 想定外のレスポンスデータの結果を生成する |
| static <T> Result<T> | unknown(String message) | 不明な結果を生成する |
| static <T> Result<T> | versionInconsistent() | バージョン不整合の結果を生成する |
コンストラクタの詳細
Result
public Result(Result.State state, T data, String errorMessage)
指定された状態、関連データおよびエラーメッセージで新しいResultを生成する
パラメータ:
state- 結果の状態data- 結果に関連するデータerrorMessage- エラーメッセージ
Result
public Result(Result.State state, T data)
指定された状態、関連データで新しいResultを生成する
パラメータ:
state- 結果の状態data- 結果に関連するデータ
Result
public Result(Result.State state)
指定された状態で新しいResultを生成する
パラメータ:
state- 結果の状態
メソッドの詳細
getState
public Result.State getState()
結果の状態を返す
戻り値:
- 結果の状態
getData
public T getData()
結果に関連するデータを返す
戻り値:
- 結果に関連するデータ
getErrorMessage
public String getErrorMessage()
エラーメッセージを返す
戻り値:
- エラーメッセージ
success
public static <T> Result<T> success(T data)
成功した結果を生成する
型パラメータ:
T- 結果の関連データ型
パラメータ:
data- 結果に関連するデータ
戻り値:
- 成功した結果のResultオブジェクト
success
public static <T> Result<T> success(String message)
成功した結果を生成する
型パラメータ:
T- 結果の関連データ型
パラメータ:
message- メッセージ
戻り値:
- 成功した結果のResultオブジェクト
unknown
public static <T> Result<T> unknown(String message)
不明な結果を生成する
型パラメータ:
T- 結果の関連データ型
パラメータ:
message- メッセージ
戻り値:
- 不明な結果のResultオブジェクト
serviceNotConnected
public static <T> Result<T> serviceNotConnected()
サービス未接続の結果を生成する
型パラメータ:
T- 結果の関連データ型
戻り値:
- サービス未接続の結果のResultオブジェクト
glassNotConnected
public static <T> Result<T> glassNotConnected()
グラスデバイス未接続の結果を生成する
型パラメータ:
T- 結果の関連データ型
戻り値:
- グラスデバイス未接続の結果のResultオブジェクト
versionInconsistent
public static <T> Result<T> versionInconsistent()
バージョン不整合の結果を生成する
型パラメータ:
T- 結果の関連データ型
戻り値:
- バージョ ン不整合の結果のResultオブジェクト
notFoundMirzaApp
public static <T> Result<T> notFoundMirzaApp()
MiRZAアプリが見つからない結果を生成する
型パラメータ:
T- 結果の関連データ型
戻り値:
- MiRZAアプリが見つからない結果のResultオブジェクト
mirzaAppInNotSpacesMode
public static <T> Result<T> mirzaAppInNotSpacesMode()
MiRZAアプリ側が MRモードになっていないという結果を生成する
型パラメータ:
T- 結果の関連データ型
戻り値:
- MiRZAアプリ側がMRモードになっていない結果のResultオブジェクト
glassNotPaired
public static <T> Result<T> glassNotPaired()
グラスデバイス未ペアリングの結果を生成する
型パラメータ:
T- 結果の関連データ型
戻り値:
- グラスデバイス未ペアリングの結果のResultオブジェクト
serviceError
public static <T> Result<T> serviceError(String errorMessage)
サービスエラーの結果を生成する
サービス連携時の処理で何かしらのエラーが発生した場合を想定する。
型パラメータ:
T- 結果の関連データ型
パラメータ:
errorMessage- エラーメッセージ
戻り値:
- サービスエラーの結果のResultオブジェクト
unexpectedResponseData
public static <T> Result<T> unexpectedResponseData(String errorMessage)
想定外のレスポンスデータの結果を生成する
型パラメータ:
T- 結果の関連データ型
パラメータ:
errorMessage- エラーメッセージ
戻り値:
- 想定外のレスポンスデータの結果のResultオブジェクト
glassNotConnectedOrTimeout
public static <T> Result<T> glassNotConnectedOrTimeout()
グラスデバイス未接続またはタイムアウトの結果を生成する
型パラメータ:
T- 結果の関連データ型
戻り値:
- グラスデバイス未接続またはタイムアウトの結果のResultオブジェクト
isSuccess
public boolean isSuccess()
連携結果の状態が成功しているかを判断する
戻り値:
- 成功したか否か。trueの場合は成功、falseの場合は成功以外。