モジュール java.base
パッケージ java.lang.foreign

インタフェースFunctionDescriptor

public sealed interface FunctionDescriptor
FunctionDescriptorは、JavaプラットフォームのプレビューAPIです。
プレビュー機能が有効な場合のみ、プログラムでFunctionDescriptorを使用できます。
プレビュー機能は、今後のリリースで削除するか、Javaプラットフォームの永続機能にアップグレードすることができます。
関数記述子は、外部関数のシグネチャをモデル化します。 関数記述子は、0個以上の引数レイアウトと、0個または1個の戻りレイアウトで構成されます。 関数記述子を使用して、「ダウンコール・メソッド・ハンドル」PREVIEWおよび「アップコール・スタブ」PREVIEWを作成します。
実装要件:
クラスの実装は、不変、スレッド・セーフおよびvalue-basedです。
導入されたバージョン:
19
関連項目:

  • メソッドの詳細

    • returnLayout

      Optional<MemoryLayoutPREVIEW> returnLayout()
      この関数記述子の戻りレイアウト(もしあれば)を返します。
      戻り値:
      この関数記述子の戻りレイアウト(もしあれば)

    • argumentLayouts

      List<MemoryLayoutPREVIEW> argumentLayouts()
      この関数記述子(変更不可能なリストとして)の引数レイアウトを返します。
      戻り値:
      この関数記述子の引数レイアウト (変更不可能なリストとして)

    • appendArgumentLayouts

      FunctionDescriptorPREVIEW appendArgumentLayouts(MemoryLayoutPREVIEW... addedLayouts)
      この関数記述子の引数レイアウトに、指定された引数レイアウトが追加された関数記述子を返します。
      パラメータ:
      addedLayouts - 追加する引数のレイアウト。
      戻り値:
      追加の引数レイアウトが指定された新しい関数記述子。
      例外:
      IllegalArgumentException - addedLayoutsのレイアウトの1つがパディング・レイアウトの場合。

    • insertArgumentLayouts

      FunctionDescriptorPREVIEW insertArgumentLayouts(int index, MemoryLayoutPREVIEW... addedLayouts)
      指定された索引に挿入された引数レイアウトを持つ関数記述子を、この関数記述子の引数レイアウト配列に戻します。
      パラメータ:
      index - 引数を挿入する索引
      addedLayouts - 指定された索引に挿入する引数レイアウト。
      戻り値:
      追加の引数レイアウトが指定された新しい関数記述子。
      例外:
      IllegalArgumentException - addedLayoutsのレイアウトの1つがパディング・レイアウトの場合。
      IllegalArgumentException - index < 0 || index > argumentLayouts().size()の場合。

    • changeReturnLayout

      FunctionDescriptorPREVIEW changeReturnLayout(MemoryLayoutPREVIEW newReturn)
      指定された戻りレイアウトで関数記述子を返します。
      パラメータ:
      newReturn - 新しい戻りレイアウト。
      戻り値:
      指定された戻りレイアウトを持つ新しい関数記述子。
      例外:
      IllegalArgumentException - newReturnがパディング・レイアウトの場合。

    • dropReturnLayout

      FunctionDescriptorPREVIEW dropReturnLayout()
      戻りレイアウトのない新しい関数記述子を返します。
      戻り値:
      戻りレイアウトのない新しい関数記述子

    • toMethodType

      MethodType toMethodType()
      この関数記述子のレイアウトのキャリア・タイプで構成されるメソッド・タイプを返します。

      レイアウトLのキャリア・タイプは、次のように決定されます:

      APIのノート:
      関数記述子にパディング・レイアウトを含めることはできません。 そのため、パディング・レイアウトを運送業者タイプにマップする方法を指定する必要はありません。
      戻り値:
      この関数記述子のレイアウトのキャリア・タイプで構成されるメソッド・タイプ。

    • of

      static FunctionDescriptorPREVIEW of(MemoryLayoutPREVIEW resLayout, MemoryLayoutPREVIEW... argLayouts)
      指定された戻りおよび引数のレイアウトを使用して関数記述子を作成します。
      パラメータ:
      resLayout - 戻りレイアウト。
      argLayouts - 引数のレイアウト。
      戻り値:
      指定された戻りおよび引数レイアウトを持つ新しい関数記述子。
      例外:
      IllegalArgumentException - resLayoutがパディング・レイアウトの場合。
      IllegalArgumentException - argLayoutsのレイアウトの1つがパディング・レイアウトの場合。

    • ofVoid

      static FunctionDescriptorPREVIEW ofVoid(MemoryLayoutPREVIEW... argLayouts)
      指定された引数レイアウトを持つ関数記述子を作成し、戻りレイアウトは作成しません。 これは、値を返さない関数をモデル化する場合に便利です。
      パラメータ:
      argLayouts - 引数のレイアウト。
      戻り値:
      指定された引数レイアウトを持つ新しい関数記述子。
      例外:
      IllegalArgumentException - argLayoutsのレイアウトの1つがパディング・レイアウトの場合。