インタフェースModuleAttribute

すべてのスーパー・インタフェース:

Attribute<ModuleAttribute>, ClassElement, ClassFileElement

public sealed interface ModuleAttribute extends Attribute<ModuleAttribute>, ClassElement

Module属性(JVMS 4.7.25)をモデル化します。この属性は、常にモジュール記述子を「表す」クラス上に表示されます。

この属性はクラスにのみ表示され、クラス内の「複数のインスタンス」は許可されません。 「定数プール」へのデータ依存性があります。

この属性は、Java SE Platformバージョン9のメジャー・バージョン53で導入されました。

Java Virtual Machine仕様を参照してください:

「4.7.25 Module属性」

導入されたバージョン:

24

関連項目:

• Attributes.module()
• ModuleDescriptor

ネストされたクラスのサマリー

ネストされたクラス

修飾子と型	インタフェース	説明
static interface	ModuleAttribute.ModuleAttributeBuilder	Module属性のビルダー。

メソッドのサマリー

修飾子と型	メソッド	説明
List<ModuleExportInfo>	exports()	このモジュールによってエクスポートされたパッケージを返します。
default boolean	has(AccessFlag flag)	モジュール・フラグの存在をテストします。
default Set<AccessFlag>	moduleFlags()	モジュールのモジュール・フラグを列挙定数のセットとして返します。
int	moduleFlagsMask()	モジュールのモジュール・フラグをビット・マスクとして返します。
ModuleEntry	moduleName()	モジュールの名前を返します。
Optional<Utf8Entry>	moduleVersion()	モジュールのバージョンを返します(存在する場合)。
static ModuleAttribute	of(ModuleEntry moduleName, int moduleFlags, Utf8Entry moduleVersion, Collection<ModuleRequireInfo> requires, Collection<ModuleExportInfo> exports, Collection<ModuleOpenInfo> opens, Collection<ClassEntry> uses, Collection<ModuleProvideInfo> provides)	Module属性を返します。
static ModuleAttribute	of(ModuleEntry moduleName, Consumer<ModuleAttribute.ModuleAttributeBuilder> attrHandler)	Module属性を返します。
static ModuleAttribute	of(ModuleDesc moduleName, Consumer<ModuleAttribute.ModuleAttributeBuilder> attrHandler)	Module属性を返します。
List<ModuleOpenInfo>	opens()	このモジュールによって開かれたパッケージを返します。
List<ModuleProvideInfo>	provides()	このモジュールによって提供されるサービス実装を返します。
List<ModuleRequireInfo>	requires()	このモジュールに必要なモジュールを返します。
List<ClassEntry>	uses()	このモジュールで使用されるサービスを返します。

インタフェースjava.lang.classfile.Attributeで宣言されたメソッド

attributeMapper, attributeName

メソッドの詳細

moduleName

ModuleEntry moduleName()

モジュールの名前を返します。

戻り値:

モジュールの名前

関連項目:

• ModuleDescriptor.name()

moduleFlagsMask

int moduleFlagsMask()

モジュールのモジュール・フラグをビット・マスクとして返します。 符号なしshort [0, 0xFFFF]の範囲内です。

戻り値:

モジュールのモジュール・フラグをビット・マスクとして

関連項目:

• ModuleDescriptor.modifiers()
• AccessFlag.Location.MODULE

moduleFlags

default Set<AccessFlag> moduleFlags()

モジュールのモジュール・フラグを列挙定数のセットとして返します。

戻り値:

モジュールのモジュール・フラグ(列挙定数セットとして)

スロー:

IllegalArgumentException - フラグ・マスクに未定義のビットが設定されている場合

関連項目:

• ModuleDescriptor.accessFlags()
• AccessFlag.Location.MODULE

has

default boolean has(AccessFlag flag)

モジュール・フラグの存在をテストします。

パラメータ:

flag - モジュール・フラグ

戻り値:

フラグが設定されている場合はtrue

関連項目:

• AccessFlag.Location.MODULE

moduleVersion

Optional<Utf8Entry> moduleVersion()

モジュールのバージョンを返します(存在する場合)。

戻り値:

モジュールのバージョン(存在する場合)

関連項目:

• ModuleDescriptor.version()

requires

List<ModuleRequireInfo> requires()

このモジュールに必要なモジュールを返します。

戻り値:

このモジュールに必要なモジュール

関連項目:

• ModuleDescriptor.requires()

exports

List<ModuleExportInfo> exports()

このモジュールによってエクスポートされたパッケージを返します。

戻り値:

このモジュールによってエクスポートされたパッケージ

関連項目:

• ModuleDescriptor.packages()

opens

List<ModuleOpenInfo> opens()

このモジュールによって開かれたパッケージを返します。

APIのノート:

パッケージを別のモジュールに開くと、他のモジュールは、このモジュールのメンバーと同じ完全な権限アクセス権を取得できます。 詳細は、MethodHandles.privateLookupIn(java.lang.Class<?>, java.lang.invoke.MethodHandles.Lookup)を参照してください。

戻り値:

このモジュールによって開かれたパッケージ

関連項目:

• ModuleDescriptor.opens()

uses

List<ClassEntry> uses()

このモジュールで使用されるサービスを返します。 サービスは、ServiceLoaderで検出できます。

戻り値:

このモジュールで使用されるサービス

関連項目:

• ModuleDescriptor.uses()

provides

List<ModuleProvideInfo> provides()

このモジュールによって提供されるサービス実装を返します。

戻り値:

このモジュールによって提供されるサービス実装

関連項目:

• ModuleDescriptor.provides()

of

static ModuleAttribute of(ModuleEntry moduleName, int moduleFlags, Utf8Entry moduleVersion, Collection<ModuleRequireInfo> requires, Collection<ModuleExportInfo> exports, Collection<ModuleOpenInfo> opens, Collection<ClassEntry> uses, Collection<ModuleProvideInfo> provides)

Module属性を返します。

パラメータ:

moduleName - モジュール名

moduleFlags - モジュール・フラグ

moduleVersion - モジュールのバージョンは、nullです

requires - 必要なパッケージ

exports - エクスポートされたパッケージ

opens - 開いたパッケージ

uses - 消費されたサービス

provides - 提供されたサービス

戻り値:

Module属性

of

static ModuleAttribute of(ModuleDesc moduleName, Consumer<ModuleAttribute.ModuleAttributeBuilder> attrHandler)

Module属性を返します。

パラメータ:

moduleName - モジュール名

attrHandler - ModuleAttribute.ModuleAttributeBuilderを受信するハンドラ

戻り値:

Module属性

of

static ModuleAttribute of(ModuleEntry moduleName, Consumer<ModuleAttribute.ModuleAttributeBuilder> attrHandler)

Module属性を返します。

パラメータ:

moduleName - モジュール名

attrHandler - ModuleAttribute.ModuleAttributeBuilderを受信するハンドラ

戻り値:

Module属性