VCSSL/Vnano プラグイン インターフェース 仕様書

# String Scalar Data Accessor Interface 1 (String SDAI1)
インターフェース仕様書
(org.vcssl.connect.StringScalarDataAccessorInterface1)

## 概要

String Scalar Data Accessor Interface 1 (String SDAI1) は、 主に処理系のデータコンテナが実装してサポートする、データ入出力インターフェースの一つです。

この org.vcssl.connect パッケージ内では、スクリプトエンジン側とプラグイン側との間で、必要に応じてデータ型の変換なしにデータを受け渡しするための、 複数のデータ入出力インターフェースが提供されています。

その中でこの String SDAI1 は、String 型のスカラ値に対する入出力機能を提供します。

## ステータス

このインターフェースの現在のステータスは "FINALIZED"（確定済み）です。

このインターフェースの仕様は、2022年8月31日時点で最終確定しました。今後は原則として、ドキュメントやコメント類以外の変更は加えられません。

現在は Vnano のスクリプトエンジンでサポートされ、同エンジンを搭載したアプリケーションのプラグイン開発において利用できます。

## ライセンス

このインターフェースは、実質的な著作権フリー/パブリックドメインである CC0 に基づいて公開されています。

## フィールド/メソッド等の一覧

INTERFACE_TYPE_ID
  プラグインのロード時に参照される、このインターフェースの形式ID（値: "STRING_SDAI"）です。
INTERFACE_GENERATION
  このインターフェースの世代名です（値: "1"）。
void setStringScalarData(String data)
  String 型のスカラ値を設定します。
String getStringScalarData()
  String 型のスカラ値を取得します。
boolean hasStringScalarData()
  String 型のスカラ値を取得可能かどうかを判定します。

## フィールド

名前 | INTERFACE_TYPE_ID
--- | ---
値の意味 | プラグインのロード時に参照される、このインターフェースの形式ID（値: "STRING_SDAI"）です。
データ型 | static final String

名前 | INTERFACE_GENERATION
--- | ---
値の意味 | このインターフェースの世代名です（値: "1"）。
データ型 | static final String

## メソッド

名前 | setStringScalarData
--- | ---
宣言形式 | void setStringScalarData(String data)
機能 | String 型のスカラ値を設定します。
引数 | data: 設定するスカラ値
戻り値 | なし

名前 | getStringScalarData
--- | ---
宣言形式 | String getStringScalarData()
機能 | String 型のスカラ値を取得します。
引数 | なし
戻り値 | スカラ値

名前 | hasStringScalarData
--- | ---
宣言形式 | boolean hasStringScalarData()
機能 | String 型のスカラ値を取得可能かどうかを判定します。
引数 | なし
戻り値 | String 型のスカラ値を取得可能であれば true が返されます。