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

クラス Documenter

java.lang.ObjectSE
org.springframework.modulith.docs.Documenter
public class Documenter extends ObjectSE
ApplicationModules のドキュメントを作成するための API。
作成者:
Oliver Drotbohm

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

    • Documenter

      public Documenter(ClassSE<?> modulithType)
      デフォルトの出力フォルダー (spring-modulith-docs) に、指定されたモジュリス型に対して作成された ApplicationModules の新しい Documenter を作成します。
      パラメーター:
      modulithType - null であってはなりません。

    • Documenter

      public Documenter(ApplicationModules modules)
      指定された ApplicationModules インスタンスの新しい Documenter をデフォルトの出力フォルダー (spring-modulith-docs) に作成します。
      パラメーター:
      modules - null であってはなりません。

    • Documenter

      public Documenter(ApplicationModules modules, StringSE outputFolder)
      指定された ApplicationModules および出力フォルダーに対して新しい Documenter を作成します。
      パラメーター:
      modules - null であってはなりません。
      outputFolder - null または空であってはなりません。

  • メソッドの詳細

    • withOutputFolder

      @DeprecatedSE(forRemoval=true) public Documenter withOutputFolder(StringSE outputFolder)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      Documenter(org.springframework.modulith.core.ApplicationModules,java.lang.String) を直接使用してください。
      生成されたファイルを書き込む出力フォルダーをカスタマイズします。デフォルトは "spring-modulith-docs" です。
      パラメーター:
      outputFolder - null または空であってはなりません。
      戻り値:
      null になることはありません。

    • writeDocumentation

      public Documenter writeDocumentation()
      利用可能なすべてのドキュメントを書き込みます。
      • 概要コンポーネント図としてのモジュールのセット全体。
      • すべての上流モジュールを含む、モジュールごとの個別のコンポーネント図。
      • 各モジュールのモジュールキャンバス。
      Documenter.DiagramOptions.defaults() と Documenter.CanvasOptions.defaults() を使用します。
      戻り値:
      現在のインスタンスが null になることはありません。

    • writeDocumentation

      public Documenter writeDocumentation(Documenter.DiagramOptions options, Documenter.CanvasOptions canvasOptions)
      利用可能なすべてのドキュメントを書き込みます。
      • 概要コンポーネント図としてのモジュールのセット全体。
      • すべての上流モジュールを含む、モジュールごとの個別のコンポーネント図。
      • 各モジュールのモジュールキャンバス。
      パラメーター:
      options - null であってはなりません。
      canvasOptions - null であってはなりません。
      戻り値:
      現在のインスタンスが null になることはありません。

    • writeModulesAsPlantUml

      public Documenter writeModulesAsPlantUml()
      Documenter.DiagramOptions.defaults() を使用して、すべての ApplicationModules の PlantUML コンポーネント図を書き込みます。
      戻り値:
      現在のインスタンスが null になることはありません。

    • writeModulesAsPlantUml

      public Documenter writeModulesAsPlantUml(Documenter.DiagramOptions options)
      指定された Documenter.DiagramOptions を使用して、すべての ApplicationModules の PlantUML コンポーネント図を書き込みます。
      パラメーター:
      options - null であってはなりません。
      戻り値:
      現在のインスタンスが null になることはありません。

    • writeIndividualModulesAsPlantUml

      public Documenter writeIndividualModulesAsPlantUml()

    • writeIndividualModulesAsPlantUml

      public Documenter writeIndividualModulesAsPlantUml(Documenter.DiagramOptions options)
      すべての個別モジュールのコンポーネント図を書き込みます。
      パラメーター:
      options - null であってはなりません。
      戻り値:
      現在のインスタンスが null になることはありません。

    • writeModuleAsPlantUml

      public Documenter writeModuleAsPlantUml(ApplicationModule module)
      指定された ApplicationModule の PlantUML コンポーネント図を書き込みます。
      パラメーター:
      module - null であってはなりません。
      戻り値:
      現在のインスタンスが null になることはありません。

    • writeModuleAsPlantUml

      public Documenter writeModuleAsPlantUml(ApplicationModule module, Documenter.DiagramOptions options)
      指定された ApplicationModule の PlantUML コンポーネント図を指定されたレンダリング Documenter.DiagramOptions で書き込みます。
      パラメーター:
      module - null であってはなりません。
      options - null であってはなりません。
      戻り値:
      現在のインスタンスが null になることはありません。

    • writeModuleCanvases

      public Documenter writeModuleCanvases()
      Documenter.DiagramOptions.defaults() を使用してすべてのモジュールキャンバスを書き込みます。
      戻り値:
      現在のインスタンスが null になることはありません。

    • writeModuleCanvases

      public Documenter writeModuleCanvases(Documenter.CanvasOptions options)
      指定された Documenter.DiagramOptions を使用してすべてのモジュールキャンバスを書き込みます。
      パラメーター:
      options - null であってはなりません。
      戻り値:
      現在のインスタンスが null になることはありません。

    • toModuleCanvas

      StringSE toModuleCanvas(ApplicationModule module)

    • toModuleCanvas

      StringSE toModuleCanvas(ApplicationModule module, StringSE apiBase)

    • toModuleCanvas

      StringSE toModuleCanvas(ApplicationModule module, Documenter.CanvasOptions options)

    • getModules

      ApplicationModules getModules()

    • toPlantUml

      StringSE toPlantUml()