Toruca (Star-2.0 (APIリファレンス))

トルカデータを新規に作成し、登録するためには、コンストラクタにより Toruca オブジェクトを生成します。生成したオブジェクトに対してデータ１等の設定、取得、および TorucaStore.addEntry(Toruca) メソッドによる登録を行うことができます。登録の成否にかかわらず、登録に使用した Toruca オブジェクトの状態は変化しません。

トルカデータのURL、データ１、データ２、データ３の合計サイズのチェックはこのクラスでは行いません。また、登録時（TorucaStore.addEntry(Toruca)）にも行いません。よって、トルカデータのURL、データ１、データ２、データ３の文字列の合計サイズが 0byte のトルカデータについても登録可能です。

また、トルカデータの全体サイズについてのチェックはこのクラスでは行いません。トルカデータの全体サイズのチェックは、登録時（TorucaStore.addEntry(Toruca)）に行われます。ただし、トルカデータに設定できる残りバイト数は TorucaStore.getRemainingBytes(Toruca) メソッドによって調べることができます。

以下のメソッド・コンストラクタ呼び出しにおいて、トルカオブジェクト生成の元となったトルカデータに不正な値が含まれていた場合、その値を取得するメソッドによって返される値は、機種依存となります。

トルカデータの各要素を取得するメソッドの説明において、「設定されていない場合」とは、構成要素の値が null である場合、または要素自体がない場合とします。

導入されたバージョン:: Star-1.0

フィールドの概要
`static String`	`TYPE_CARD` トルカ種別の一つで、トルカカードのことを表します (="card")。
`static String`	`TYPE_SNIP` トルカ種別の一つで、トルカスニップのことを表します (="snip")。

コンストラクタの概要
`Toruca()` トルカデータを生成します。
`Toruca(byte[] data)` トルカデータを生成します。

メソッドの概要
`byte[]`	`getBody()` トルカカードの本体部を取得します。
`byte[]`	`getCategory()` カテゴリを取得します。
`int`	`getColorID()` 色IDを取得します。
`String`	`getData1()` データ１を取得します。
`String`	`getData2()` データ２を取得します。
`String`	`getData3()` データ３を取得します。
`java.util.Date`	`getExpirationDate()` このトルカデータの有効期限を取得します。
`String`	`getIPID()` コンテンツ開発者が独自で指定しているID( IP-ID )を取得します。
`java.util.Date`	`getLastModified()` このトルカデータの最終更新日時を取得します。
`String`	`getProperty(String key)` 指定されたキーに該当するプロパティ値を取得します。
`int`	`getRedistributionID()` このトルカデータの再配布識別子を取得します。
`String`	`getSortID()` トルカデータのソートに用いるための読み仮名(カナID)を取得します。
`String`	`getType()` トルカ種別を取得します。
`String`	`getURL()` トルカカードの取得先URLを取得します。
`byte[]`	`getVersion()` トルカデータのバージョンを取得します。
`void`	`setBody(byte[] body)` トルカカードの本体部を設定します。
`void`	`setCategory(byte[] code)` カテゴリを設定します。
`void`	`setData1(String data1)` データ１を設定します。
`void`	`setData2(String data2)` データ２を設定します。
`void`	`setData3(String data3)` データ３を設定します。
`void`	`setProperty(String key, String value)` 指定されたキーに該当するプロパティ値を設定します。
`void`	`setType(String type)` トルカ種別を設定します。
`void`	`setURL(String url)` トルカカードの取得先URLを設定します。
`void`	`setVersion(byte[] version)` トルカデータのバージョンを設定します。

クラス Object から継承されたメソッド
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

フィールドの詳細

TYPE_CARD

public static final String TYPE_CARD

トルカ種別の一つで、トルカカードのことを表します (="card")。

関連項目:: 定数フィールド値

TYPE_SNIP

public static final String TYPE_SNIP

トルカ種別の一つで、トルカスニップのことを表します (="snip")。

関連項目:: 定数フィールド値

コンストラクタの詳細

Toruca

public Toruca()

トルカデータを生成します。

初期状態は以下のようになります。

バージョン : {0x01, 0x00}
トルカ種別 : "snip"
URL : null
データ１ : null
データ２ : null
データ３ : null
カテゴリ : null
IP-ID : null
色ID : -1
カナID : null
再配布識別子 : 4:再配布可且つ更新可
有効期限 : null
最終更新日時 : null
本体部 : null

IP-ID 、色ID、カナID、再配布識別子、有効期限、最終更新日時については、 set 系メソッドが用意されていないため、このコンストラクタにて初期化された値を変更することはできません。

Toruca

public Toruca(byte[] data)

トルカデータを生成します。

このコンストラクタの引数に指定できるバイナリデータは、トルカ仕様に準拠したフォーマットのバイナリデータです。それ以外のバイナリデータが指定された場合、「トルカ仕様に準拠していない」という理由で例外が発生します。

引数に指定されたバイナリデータのトルカデータの各要素は、以下の方針でエラーチェックが行われます。

引数に指定されたバイナリデータにトルカデータとして必須の要素が含まれていなかった場合に、「トルカ仕様に準拠していない」という理由で IllegalArgumentException が発生するか、各 set 系メソッドと同等のエラーチェックにより NullPointerException が発生するかは機種依存です。
バージョン、トルカ種別については、set 系メソッドと同等のエラーチェックを行います。この過程で内部的にエラー（例外）を検出した場合は、その例外がそのままスローされます。
URLについては、 set 系メソッドと同等のエラーチェックが行われるかどうかは機種依存です。各 set 系メソッドと同等のエラーチェックを行う場合、この過程で内部的にエラー（例外）を検出した場合は、その例外がそのままスローされます。
データ１、データ２、データ３、本体部、カテゴリーコード、IP-IDについては、トルカ仕様に準拠していない値(不正な値)が指定された場合に IllegalArgumentException が発生するかどうかは機種依存です。
色ID、カナID、再配布識別子、有効期限については、各要素の値に対�

com.docomostar.system クラス Toruca

TYPE_CARD

TYPE_SNIP

Toruca

Toruca

com.docomostar.system
クラス Toruca