パッケージ org.springframework.modulith.core

クラス ApplicationModule

java.lang.ObjectSE
org.springframework.modulith.core.ApplicationModule
実装済みのインターフェース一覧:
ComparableSE<ApplicationModule>
public class ApplicationModule extends ObjectSE implements ComparableSE<ApplicationModule>
アプリケーションモジュール。
作成者:
Oliver Drotbohm

  • コンストラクターの詳細

    • ApplicationModule

      ApplicationModule(ApplicationModuleSource source)
      指定された ApplicationModuleSource から新しい ApplicationModule を作成します。
      パラメーター:
      source - null であってはなりません。

    • ApplicationModule

      ApplicationModule(ApplicationModuleSource source, JavaPackages exclusions)
      指定された基本パッケージに対して新しい ApplicationModule を作成し、完全修飾モジュール名を使用するかどうかを指定します。
      パラメーター:
      source - null であってはなりません。
      exclusions - null であってはなりません。

  • メソッドの詳細

    • getBasePackage

      public JavaPackage getBasePackage()
      モジュールの基本パッケージを返します。
      戻り値:
      basePackage

    • getNamedInterfaces

      public NamedInterfaces getNamedInterfaces()
      モジュールによって公開されるすべての NamedInterfaces を返します。
      戻り値:
      namedInterfaces が null になることはありません。

    • getName

      @DeprecatedSE public StringSE getName()
      使用すべきではありません。
      1.3 以降、代わりに getIdentifier() を使用してください。
      モジュールの論理名を返します。
      戻り値:
      null または空になることはありません。

    • getIdentifier

      public ApplicationModuleIdentifier getIdentifier()
      モジュールの論理識別子を返します。
      戻り値:
      null になることはありません。
      導入:
      1.3

    • getDisplayName

      public StringSE getDisplayName()
      表示目的で ApplicationModule の名前を返します。
      戻り値:
      null または空になることはありません。

    • getDependencies

      @DeprecatedSE public ApplicationModuleDependencies getDependencies(ApplicationModules modules, DependencyType... type)
      使用すべきではありません。
      1.3 以来。代わりに getDirectDependencies(ApplicationModules, DependencyType...) を使用してください。
      現在の ApplicationModule の ApplicationModule.AllowedDependencies を返します。
      パラメーター:
      modules - null であってはなりません。
      type - null であってはなりません。
      戻り値:
      null になることはありません。

    • getDirectDependencies

      public ApplicationModuleDependencies getDirectDependencies(ApplicationModules modules, DependencyType... type)
      現在の ApplicationModule の直接の ApplicationModuleDependencies を返します。
      パラメーター:
      modules - null であってはなりません。
      type - null であってはなりません。
      戻り値:
      null になることはありません。

    • getAllDependencies

      public ApplicationModuleDependencies getAllDependencies(ApplicationModules modules, DependencyType... type)
      現在の ApplicationModule のすべての ApplicationModuleDependencies (推移的なものも含む) を返します。
      パラメーター:
      modules - null であってはなりません。
      type - null であってはなりません。
      戻り値:
      null になることはありません。

    • getEventsListenedTo

      public ListSE<com.tngtech.archunit.core.domain.JavaClass> getEventsListenedTo(ApplicationModules modules)
      現在のモジュールがイベントリスナーを公開しているすべてのイベント型を返します。
      パラメーター:
      modules - null であってはなりません。
      戻り値:

    • getPublishedEvents

      public ListSE<EventType> getPublishedEvents()
      モジュールによって発行されたすべての EventType を返します。
      戻り値:
      null になることはありません。

    • getValueTypes

      public ListSE<com.tngtech.archunit.core.domain.JavaClass> getValueTypes()
      モジュールに含まれるすべての値の型を返します。
      戻り値:
      null になることはありません。

    • getAggregateRoots

      public ListSE<com.tngtech.archunit.core.domain.JavaClass> getAggregateRoots()
      集約ルートとみなされるすべての型を返します。
      戻り値:
      null になることはありません。

    • getBootstrapDependencies

      public StreamSE<ApplicationModule> getBootstrapDependencies(ApplicationModules modules)
      現在のモジュールの型が依存する型を含むすべてのモジュールを返します。
      パラメーター:
      modules - null であってはなりません。
      戻り値:

    • getBootstrapDependencies

      public StreamSE<ApplicationModule> getBootstrapDependencies(ApplicationModules modules, DependencyDepth depth)

    • getBootstrapBasePackages

      public StreamSE<JavaPackage> getBootstrapBasePackages(ApplicationModules modules, DependencyDepth depth)
      現在のモジュールのすべての JavaPackage (依存関係によるものを含む) を返します。
      パラメーター:
      modules - null であってはなりません。
      depth - null であってはなりません。
      戻り値:

    • getSpringBeans

      public ListSE<SpringBean> getSpringBeans()
      モジュールに含まれるすべての SpringBean を返します。
      戻り値:
      null になることはありません。

    • getSpringBeans

      public ListSE<SpringBean> getSpringBeans(ClassSE<?> type)
      指定された型に割り当て可能なすべての SpringBean を返します。
      パラメーター:
      type - null であってはなりません。
      戻り値:
      null になることはありません。
      導入:
      1.4

    • getArchitecturallyEvidentType

      public ArchitecturallyEvidentType getArchitecturallyEvidentType(ClassSE<?> type)
      指定された型の ArchitecturallyEvidentType を返します。
      パラメーター:
      type - null であってはなりません。
      戻り値:
      null になることはありません。
      例外:
      IllegalArgumentExceptionSE - 指定された型がモジュール型ではない場合。

    • contains

      public boolean contains(com.tngtech.archunit.core.domain.JavaClass type)
      現在のモジュールに指定された型が含まれているかどうかを返します。
      パラメーター:
      type - null であってはなりません。

    • contains

      public boolean contains(ClassSE<?> type)
      現在のモジュールに指定された型が含まれているかどうかを返します。
      パラメーター:
      type - null であってはなりません。

    • couldContain

      public boolean couldContain(ClassSE<?> type)
      モジュールが、現在のインスタンスの実際の型とは独立して、特定の型を格納できるかどうかを返します。この不一致は通常、製品コードとテストコードの違いによって発生します。前者から構築されたモジュールは、パッケージ空間内にテスト型を含みません。これに対し、このメソッドは、テスト型が論理的にモジュールにも属していることを認識します。
      パラメーター:
      type - null であってはなりません。
      導入:
      1.4.6, 2.0.1
      関連事項:

    • getType

      public OptionalSE<com.tngtech.archunit.core.domain.JavaClass> getType(StringSE candidate)
      指定された候補の単純型名または完全修飾型名の JavaClass を返します。
      パラメーター:
      candidate - null または空であってはなりません。
      戻り値:
      null になることはありません。

    • isExposed

      public boolean isExposed(com.tngtech.archunit.core.domain.JavaClass type)
      指定された JavaClass が現在のモジュールによって公開されているかどうか、つまりモジュールの名前付きインターフェースの一部であるかどうかを返します。
      パラメーター:
      type - null であってはなりません。

    • isExposed

      public boolean isExposed(ClassSE<?> type)
      指定された JavaClass が現在のモジュールによって公開されているかどうか、つまりモジュールの名前付きインターフェースの一部であるかどうかを返します。
      パラメーター:
      type - null であってはなりません。
      導入:
      1.2.8, 1.3.2

    • verifyDependencies

      public void verifyDependencies(ApplicationModules modules)

    • detectDependencies

      public Violations detectDependencies(ApplicationModules modules)

    • isRootModule

      public boolean isRootModule()
      モジュールがルートモジュールとみなされるかどうか、つまり、構成された基本パッケージごとに作成された人工的なモジュールであるかどうかを返します。
      戻り値:
      モジュールがルートモジュールとみなされるかどうか。
      導入:
      1.1

    • contains

      public boolean contains(StringSE candidate)
      指定されたモジュールに、指定された単純名または完全修飾名の型が含まれているかどうかを返します。
      パラメーター:
      candidate - null であってはなりません。
      導入:
      1.3

    • toString

      public StringSE toString(@Nullable ApplicationModules modules)

    • hasBasePackage

      boolean hasBasePackage(StringSE candidate)
      モジュールに指定された名前の基本パッケージがあるかどうかを返します。
      パラメーター:
      candidate - null または空であってはなりません。
      戻り値:
      モジュールに指定された名前の基本パッケージがあるかどうか。
      導入:
      1.1

    • getSpringBeansInternal

      Classes getSpringBeansInternal()

    • getAllowedDependencies

      public ApplicationModule.AllowedDependencies getAllowedDependencies(ApplicationModules modules)
      明示的に宣言されているか、指定された ApplicationModules インスタンスで共有として定義されている、宣言済みの許可されたすべてのモジュール依存関係を返します。
      パラメーター:
      modules - null であってはなりません。
      戻り値:
      null になることはありません。
      導入:
      1.4.2、以前はプライベートパッケージ

    • containsPackage

      boolean containsPackage(StringSE packageName)
      ApplicationModule に指定された名前のパッケージが含まれているかどうかを返します。これは、指定されたパッケージがモジュールの基本パッケージであるか、そのサブパッケージであることを意味します。
      パラメーター:
      packageName - null または空であってはなりません。
      戻り値:
      ApplicationModule に指定された名前のパッケージが含まれているかどうか。
      導入:
      1.0.2

    • isOpen

      public boolean isOpen()
      モジュールがオープンであるかどうかを返します。
      導入:
      1.4.2、以前は 1.2 以来非公開のパッケージでした。
      関連事項:

    • containsTypeInAnyParent

      boolean containsTypeInAnyParent(com.tngtech.archunit.core.domain.JavaClass type, ApplicationModules modules)
      指定された型が現在のモジュールの親モジュールのいずれかに含まれているかどうかを返します。
      パラメーター:
      type - null であってはなりません。
      modules - null であってはなりません。
      導入:
      1.3

    • getDependencies

      public ApplicationModuleDependencies getDependencies(ApplicationModules modules, DependencyDepth depth, DependencyType... types)

    • equals

      public boolean equals(ObjectSE obj)
      オーバーライド:
      クラス ObjectSE の equalsSE 

    • hashCode

      public int hashCode()
      オーバーライド:
      クラス ObjectSE の hashCode 

    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSE の toString 

    • compareTo

      public int compareTo(ApplicationModule o)
      次で指定:
      インターフェース ComparableSE<ApplicationModule> の compareToSE 

    • getParentModule

      OptionalSE<ApplicationModule> getParentModule(ApplicationModules modules)
      現在のモジュールの直下の親モジュールを返します（存在する場合）。
      パラメーター:
      modules - null であってはなりません。
      戻り値:
      null になることはありません。
      導入:
      1.3

    • getDirectlyNestedModules

      CollectionSE<ApplicationModule> getDirectlyNestedModules(ApplicationModules modules)
      現在の ApplicationModule 内に直接ネストされている ApplicationModule を返します。
      パラメーター:
      modules - null であってはなりません。
      戻り値:
      null になることはありません。
      導入:
      1.3

    • getNestedModules

      CollectionSE<ApplicationModule> getNestedModules(ApplicationModules modules)
      ネストされたモジュールに含まれるものも含め、現在の ApplicationModule のネストされた ApplicationModule をすべて順番に返します。
      パラメーター:
      modules - null であってはなりません。
      戻り値:
      null になることはありません。
      導入:
      1.3

    • getClasses

      Classes getClasses()
      戻り値:
      クラス

    • getInternalTypes

      public CollectionSE<com.tngtech.archunit.core.domain.JavaClass> getInternalTypes()
      モジュール内部のすべての型を返します。
      戻り値:
      null になることはありません。
      導入:
      1.4