com.nttdocomo.device.felica
クラス PurseDirectData

Object
  com.nttdocomo.device.felica.FelicaData
      com.nttdocomo.device.felica.PurseData
          com.nttdocomo.device.felica.PurseDirectData

public final class PurseDirectData

extends PurseData

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

パースサービス(ダイレクトアクセス、リードオンリアクセス)で使用する ブロックデータのクラスです。

OfflineFelica.read(ReadParameters)にて、 パースサービスのデータを読み込む場合、 アクセスの種類に関係なくこのクラスのオブジェクトが返ります。

導入されたバージョン:

DoJa-3.0 (506iC)、DoJa-3.5 (900iC)

フィールドの概要

クラス com.nttdocomo.device.felica.FelicaData から継承したフィールド

TYPE_DIRECT_DATA, TYPE_PURSE_CASHBACK_DATA, TYPE_PURSE_DECREMENT_DATA, TYPE_PURSE_DIRECT_DATA

コンストラクタの概要

PurseDirectData(long purseData, long cashBackData, byte[] userData, int execID)
パースデータ、キャッシュバックデータ、ユーザデータ、 実行IDを指定してPurseDirectDataを生成します。

メソッドの概要

long	getCashbackData() キャッシュバックデータを返します。
long	getPurseData() パースデータを返します。
byte[]	getUserData() ユーザデータを返します。
void	setCashbackData(long cashbackData) 指定されたcashbackDataをキャッシュバックデータとして設定します。
void	setPurseData(long purseData) 指定されたpurseDataをパースデータとして設定します。
void	setUserData(byte[] userData) 指定されたuserDataをユーザデータとして設定します。

クラス com.nttdocomo.device.felica.PurseData から継承したメソッド

getExecID, setExecID

クラス com.nttdocomo.device.felica.FelicaData から継承したメソッド

getDataType

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

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

コンストラクタの詳細

PurseDirectData

public PurseDirectData(long purseData,
                       long cashBackData,
                       byte[] userData,
                       int execID)

パースデータ、キャッシュバックデータ、ユーザデータ、 実行IDを指定してPurseDirectDataを生成します。

パラメータ:

purseData - パースデータ。指定できる値については setPurseData(long) を参照して下さい。

cashBackData - キャッシュバックデータ。指定できる値については setCashbackData(long) を参照して下さい。

userData - ユーザデータ。指定できる値については setUserData(byte[]) を参照して下さい。

execID - 実行ID。 指定できる値については PurseData.setExecID(int) を参照して下さい。

例外:

UnsupportedOperationException - FeliCa機能をサポートしていない場合に発生します。

NullPointerException - 引数 userData に null が指定された場合に発生します。

IllegalArgumentException - 引数 purseData に負の値、 または 2³² 以上の値が指定された場合に発生します。

IllegalArgumentException - 引数 cashBackData に負の値、 または 2³² 以上の値が指定された場合に発生します。

IllegalArgumentException - 引数 execID に負の値、 または 2¹⁶ 以上の値が指定された場合に発生します。

メソッドの詳細

getPurseData

public long getPurseData()

パースデータを返します。

パースサービスで使用します。

戻り値:

パースデータ。

setPurseData

public void setPurseData(long purseData)

指定されたpurseDataをパースデータとして設定します。

パースサービスで使用します。

パラメータ:

purseData - パースデータ。 0 以上 2³² - 1 以下の値が指定できます。

例外:

IllegalArgumentException - 引数 purseData に負の値、 または 2³² 以上の値が指定された場合に発生します。

setCashbackData

public void setCashbackData(long cashbackData)

指定されたcashbackDataをキャッシュバックデータとして設定します。

キャッシュバックで使用します。

パラメータ:

cashbackData - キャッシュバックデータ。 0 以上 2³² - 1 以下の値が指定できます。

例外:

IllegalArgumentException - 引数 cashBackData に負の値、 または 2³² 以上の値が指定された場合に発生します。

getCashbackData

public long getCashbackData()

キャッシュバックデータを返します。

パースサービスで使用します。

戻り値:

キャッシュバックデータ。

getUserData

public byte[] getUserData()

ユーザデータを返します。

パースサービスで使用します。

戻り値:

ユーザデータ。
[DoJa-5.0 (903i) 以降] 返される配列は、 このオブジェクトが内部で保持している配列のコピーです。

setUserData

public void setUserData(byte[] userData)

指定されたuserDataをユーザデータとして設定します。

パースサービスで使用します。

パラメータ:

userData - ユーザデータ。 長さが6バイトに満たない場合はゼロパディングされます。 6バイトを越える部分は無視されます。
[DoJa-5.0 (903i) 以降] 指定された配列は、 このメソッド内でコピーされます。

例外:

NullPointerException - 引数 userData に null が指定された場合に発生します。