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

クラス ModuleResource

java.lang.ObjectSE
org.springframework.core.io.AbstractResource
org.springframework.core.io.ModuleResource
実装されたすべてのインターフェース:
InputStreamSource, Resource
public class ModuleResource extends AbstractResource
ModuleSE 解決のための Resource 実装。Module.getResourceAsStream(java.lang.String)SE 経由で getInputStream() アクセスを実行します。

あるいは、エクスポートされたリソースの場合は ClassPathResource を介してモジュールパスレイアウト内のリソースにアクセスすることを検討してください。または、具体的には、その特定のクラスの包含モジュール内のローカル解決のために ClassPathResource(String, Class) を介して Class を基準にしてリソースにアクセスすることを検討してください。一般的なシナリオでは、モジュールリソースはクラスパスリソースとして単に透過的に表示されるため、特別な処理はまったく必要ありません。

導入:
6.1
作成者:
Juergen Hoeller, Sam Brannen
関連事項:

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

    • ModuleResource

      public ModuleResource(ModuleSE module, StringSE path)
      指定された ModuleSE および指定されたリソースパスに対して新しい ModuleResource を作成します。
      パラメーター:
      module - 検索対象のランタイムモジュール
      path - モジュール内のリソースパス

  • メソッドの詳細

    • getModule

      public final ModuleSE getModule()
      このリソースの ModuleSE を返します。

    • getPath

      public final StringSE getPath()
      このリソースのパスを返します。

    • getInputStream

      public InputStreamSE getInputStream() throws IOExceptionSE
      インターフェースからコピーされた説明: InputStreamSource
      基礎となるリソースのコンテンツの InputStreamSE を返します。

      通常、このような呼び出しごとに新しいストリームが作成されると考えられます。

      この要件は、JavaMail などの API を考慮する場合に特に重要です。JavaMail では、メールの添付ファイルを作成するときにストリームを複数回読み取ることができる必要があります。このようなユースケースでは、各 getInputStream() コールが新しいストリームを返す必要があります。

      戻り値:
      基になるリソースの入力ストリーム (null であってはなりません)
      例外:
      FileNotFoundExceptionSE - 基盤となるリソースが存在しない場合
      IOExceptionSE - コンテンツストリームを開けなかった場合
      関連事項:

    • createRelative

      public Resource createRelative(StringSE relativePath)
      クラスからコピーされた説明: AbstractResource
      この実装は、このリソースに対して相対リソースを作成できないと想定して、FileNotFoundException をスローします。
      次で指定:
      インターフェース Resource の createRelative 
      オーバーライド:
      クラス AbstractResource の createRelative 
      パラメーター:
      relativePath - 相対パス (このリソースに関連して)
      戻り値:
      相対リソースのリソースハンドル

    • getFilename

      @Nullable public StringSE getFilename()
      クラスからコピーされた説明: AbstractResource
      この実装は、このリソース型にファイル名がないと仮定して、常に null を返します。
      次で指定:
      インターフェース Resource の getFilename 
      オーバーライド:
      クラス AbstractResource の getFilename 

    • getDescription

      public StringSE getDescription()
      インターフェースからコピーされた説明: Resource
      このリソースの説明を返します。これは、リソースを操作する際のエラー出力に使用されます。

      実装では、toString メソッドからこの値を返すことも推奨されます。

      関連事項:

    • equals

      public boolean equals(@Nullable ObjectSE obj)
      クラスからコピーされた説明: AbstractResource
      この実装は、説明文字列を比較します。
      オーバーライド:
      クラス AbstractResource の equals 
      関連事項:

    • hashCode

      public int hashCode()
      クラスからコピーされた説明: AbstractResource
      この実装は、説明のハッシュコードを返します。
      オーバーライド:
      クラス AbstractResource の hashCode 
      関連事項: