パッケージ org.springframework.util

クラス ResourceUtils

java.lang.ObjectSE
org.springframework.util.ResourceUtils

public abstract class ResourceUtils extends ObjectSE
リソースの場所をファイルシステム内のファイルに解決するユーティリティメソッド。主にフレームワーク内での内部使用向け。

コアパッケージで Spring のリソース抽象化を使用して、あらゆる種類のファイルリソースを統一的に処理することを検討してください。ResourceLoader の getResource() メソッドは、任意の場所を Resource オブジェクトに解決できます。これにより、getFile() メソッドを介してファイルシステムで java.io.File を取得できます。

導入:
1.1.5
作成者:
Juergen Hoeller
関連事項:
  • フィールドサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    static final StringSE
    クラスパスからロードするための擬似 URL プレフィックス: "classpath:"。
    static final StringSE
    ファイルシステムからロードするための URL プレフィックス: "file:"。
    static final StringSE
    通常の jar ファイルのファイル拡張子: ".jar"。
    static final StringSE
    jar ファイルからロードするための URL プレフィックス: "jar:"。
    static final StringSE
    JAR URL と JAR 内のファイルパスの区切り文字: "!/"。
    static final StringSE
    ファイルシステム内のファイルの URL プロトコル: "file"。
    static final StringSE
    jar ファイルからのエントリの URL プロトコル: "jar"。
    static final StringSE
    一般的な JBoss VFS リソースの URL プロトコル: "vfs"。
    static final StringSE
    JBoss ファイルシステムリソースの URL プロトコル: "vfsfile"。
    static final StringSE
    JBoss jar ファイルからのエントリの URL プロトコル: "vfszip"。
    static final StringSE
    war ファイルからのエントリの URL プロトコル: "war"。
    static final StringSE
    WebSphere jar ファイルからのエントリの URL プロトコル: "wsjar"。
    static final StringSE
    zip ファイルからのエントリの URL プロトコル: "zip"。
    static final StringSE
    Tomcat の war ファイルからロードするための URL プレフィックス: "war:"。
    static final StringSE
    Tomcat の WAR URL と jar パーツ間の特別な区切り文字。
  • コンストラクターのサマリー

    コンストラクター
    コンストラクター
    説明
  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    static URLSE
    指定された jar/war URL(jar ファイル内のリソースまたは jar ファイル自体を指す場合があります)から最も外側のアーカイブの URL を抽出します。
    static URLSE
    指定された URL(jar ファイル内のリソースまたは jar ファイル自体を指している場合があります)から実際の jar ファイルの URL を抽出します。
    static FileSE
    getFile(StringSE resourceLocation)
    指定されたリソースの場所を java.io.File に解決します。
    static FileSE
    getFile(URISE resourceUri)
    指定されたリソース URI を java.io.File に解決します。
    static FileSE
    getFile(URISE resourceUri, StringSE description)
    指定されたリソース URI を java.io.File に解決します。
    static FileSE
    getFile(URLSE resourceUrl)
    指定されたリソース URL を java.io.File に解決します。
    static FileSE
    getFile(URLSE resourceUrl, StringSE description)
    指定されたリソース URL を java.io.File に解決します。
    static URLSE
    getURL(StringSE resourceLocation)
    指定されたリソースの場所を java.net.URL に解決します。
    static boolean
    指定された URL がファイルシステム内のリソース、つまり
    static boolean
    指定された URL が jar ファイル自体を指しているかどうか、つまり、プロトコル "file" を持ち、".jar" 拡張子で終わるかどうかを判別します。
    static boolean
    指定された URL が jar ファイル内のリソースを指しているかどうかを判断します。たとえば、URL にプロトコル "jar"、"war"、"zip"、"vfszip"、"wsjar" が含まれているかどうか。
    static boolean
    isUrl(StringSE resourceLocation)
    指定されたリソースの場所が URL であるかどうかを返します: 特別な「クラスパス」擬似 URL または標準 URL。
    static URLSE
    toRelativeURL(URLSE root, StringSE relativePath)
    URI の構築と URL 変換を経て、指定されたルート URL と相対パスのクリーンな URL インスタンスを作成します。
    static URISE
    toURI(StringSE location)
    最初にスペースを "%20" URI エンコーディングに置き換えて、指定されたロケーション文字列の URI インスタンスを作成します。
    static URISE
    最初にスペースを "%20" URI エンコーディングに置き換えて、指定された URL の URI インスタンスを作成します。
    static URLSE
    toURL(StringSE location)
    URI の構築と URL 変換を経て、指定された場所の文字列のクリーンな URL インスタンスを作成します。
    static void
    指定された接続に "useCaches"SE フラグを設定します。false を優先しますが、フラグを jar リソースの JVM デフォルト値 (通常は true) のままにします。

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
  • フィールドの詳細

    • CLASSPATH_URL_PREFIX

      public static final StringSE CLASSPATH_URL_PREFIX
      クラスパスからロードするための擬似 URL プレフィックス: "classpath:"。
      関連事項:
    • FILE_URL_PREFIX

      public static final StringSE FILE_URL_PREFIX
      ファイルシステムからロードするための URL プレフィックス: "file:"。
      関連事項:
    • JAR_URL_PREFIX

      public static final StringSE JAR_URL_PREFIX
      jar ファイルからロードするための URL プレフィックス: "jar:"。
      関連事項:
    • WAR_URL_PREFIX

      public static final StringSE WAR_URL_PREFIX
      Tomcat の war ファイルからロードするための URL プレフィックス: "war:"。
      関連事項:
    • URL_PROTOCOL_FILE

      public static final StringSE URL_PROTOCOL_FILE
      ファイルシステム内のファイルの URL プロトコル: "file"。
      関連事項:
    • URL_PROTOCOL_JAR

      public static final StringSE URL_PROTOCOL_JAR
      jar ファイルからのエントリの URL プロトコル: "jar"。
      関連事項:
    • URL_PROTOCOL_WAR

      public static final StringSE URL_PROTOCOL_WAR
      war ファイルからのエントリの URL プロトコル: "war"。
      関連事項:
    • URL_PROTOCOL_ZIP

      public static final StringSE URL_PROTOCOL_ZIP
      zip ファイルからのエントリの URL プロトコル: "zip"。
      関連事項:
    • URL_PROTOCOL_WSJAR

      public static final StringSE URL_PROTOCOL_WSJAR
      WebSphere jar ファイルからのエントリの URL プロトコル: "wsjar"。
      関連事項:
    • URL_PROTOCOL_VFSZIP

      public static final StringSE URL_PROTOCOL_VFSZIP
      JBoss jar ファイルからのエントリの URL プロトコル: "vfszip"。
      関連事項:
    • URL_PROTOCOL_VFSFILE

      public static final StringSE URL_PROTOCOL_VFSFILE
      JBoss ファイルシステムリソースの URL プロトコル: "vfsfile"。
      関連事項:
    • URL_PROTOCOL_VFS

      public static final StringSE URL_PROTOCOL_VFS
      一般的な JBoss VFS リソースの URL プロトコル: "vfs"。
      関連事項:
    • JAR_FILE_EXTENSION

      public static final StringSE JAR_FILE_EXTENSION
      通常の jar ファイルのファイル拡張子: ".jar"。
      関連事項:
    • JAR_URL_SEPARATOR

      public static final StringSE JAR_URL_SEPARATOR
      JAR URL と JAR 内のファイルパスの区切り文字: "!/"。
      関連事項:
    • WAR_URL_SEPARATOR

      public static final StringSE WAR_URL_SEPARATOR
      Tomcat の WAR URL と jar パーツ間の特別な区切り文字。
      関連事項:
  • コンストラクターの詳細

    • ResourceUtils

      public ResourceUtils()
  • メソッドの詳細

    • isUrl

      public static boolean isUrl(@Nullable StringSE resourceLocation)
      指定されたリソースの場所が URL であるかどうかを返します: 特別な「クラスパス」擬似 URL または標準 URL。
      パラメーター:
      resourceLocation - チェックする文字列
      戻り値:
      場所が URL として適格かどうか
      関連事項:
    • getURL

      public static URLSE getURL(StringSE resourceLocation) throws FileNotFoundExceptionSE
      指定されたリソースの場所を java.net.URL に解決します。

      URL が実際に存在するかどうかはチェックしません。指定された場所が対応する URL を返すだけです。

      パラメーター:
      resourceLocation - 解決するリソースの場所: "classpath:" 疑似 URL、"file:" URL、またはプレーンファイルパス
      戻り値:
      対応する URL オブジェクト
      例外:
      FileNotFoundExceptionSE - リソースを URL に解決できない場合
      関連事項:
    • getFile

      public static FileSE getFile(StringSE resourceLocation) throws FileNotFoundExceptionSE
      指定されたリソースの場所を java.io.File、つまりファイルシステム内のファイルに解決します。

      ファイルが実際に存在するかどうかはチェックしません。指定された場所に対応する File を返すだけです。

      パラメーター:
      resourceLocation - 解決するリソースの場所: "classpath:" 疑似 URL、"file:" URL、またはプレーンファイルパス
      戻り値:
      対応する File オブジェクト
      例外:
      FileNotFoundExceptionSE - リソースがファイルシステム内のファイルに解決できない場合
      関連事項:
    • getFile

      public static FileSE getFile(URLSE resourceUrl) throws FileNotFoundExceptionSE
      指定されたリソース URL を java.io.File に、つまりファイルシステム内のファイルに解決します。
      パラメーター:
      resourceUrl - 解決するリソース URL
      戻り値:
      対応する File オブジェクト
      例外:
      FileNotFoundExceptionSE - URL をファイルシステム内のファイルに解決できない場合
      関連事項:
    • getFile

      public static FileSE getFile(URLSE resourceUrl, StringSE description) throws FileNotFoundExceptionSE
      指定されたリソース URL を java.io.File に、つまりファイルシステム内のファイルに解決します。
      パラメーター:
      resourceUrl - 解決するリソース URL
      description - URL が作成された元のリソースの説明 (たとえば、クラスパスの場所)
      戻り値:
      対応する File オブジェクト
      例外:
      FileNotFoundExceptionSE - URL をファイルシステム内のファイルに解決できない場合
    • getFile

      public static FileSE getFile(URISE resourceUri) throws FileNotFoundExceptionSE
      指定されたリソース URI を java.io.File、つまりファイルシステム内のファイルに解決します。
      パラメーター:
      resourceUri - 解決するリソース URI
      戻り値:
      対応する File オブジェクト
      例外:
      FileNotFoundExceptionSE - URL をファイルシステム内のファイルに解決できない場合
      導入:
      2.5
      関連事項:
    • getFile

      public static FileSE getFile(URISE resourceUri, StringSE description) throws FileNotFoundExceptionSE
      指定されたリソース URI を java.io.File、つまりファイルシステム内のファイルに解決します。
      パラメーター:
      resourceUri - 解決するリソース URI
      description - URI が作成された元のリソースの説明 (たとえば、クラスパスの場所)
      戻り値:
      対応する File オブジェクト
      例外:
      FileNotFoundExceptionSE - URL をファイルシステム内のファイルに解決できない場合
      導入:
      2.5
    • isFileURL

      public static boolean isFileURL(URLSE url)
      指定された URL がファイルシステムのリソースを指しているかどうか、つまりプロトコル "file"、"vfsfile"、"vfs" を持っているかどうかを確認します。
      パラメーター:
      url - チェックする URL
      戻り値:
      URL がファイルシステム URL として識別されているかどうか
      関連事項:
    • isJarURL

      public static boolean isJarURL(URLSE url)
      指定された URL が jar ファイル内のリソースを指しているかどうかを判断します。たとえば、URL にプロトコル "jar"、"war"、"zip"、"vfszip"、"wsjar" が含まれているかどうか。
      パラメーター:
      url - チェックする URL
      戻り値:
      URL が JAR URL として識別されているかどうか
      関連事項:
    • isJarFileURL

      public static boolean isJarFileURL(URLSE url)
      指定された URL が jar ファイル自体を指しているかどうか、つまり、プロトコル "file" を持ち、".jar" 拡張子で終わるかどうかを判別します。
      パラメーター:
      url - チェックする URL
      戻り値:
      URL が JAR ファイル URL として識別されているかどうか
      導入:
      4.1
      関連事項:
    • extractJarFileURL

      public static URLSE extractJarFileURL(URLSE jarUrl) throws MalformedURLExceptionSE
      指定された URL(jar ファイル内のリソースまたは jar ファイル自体を指している場合があります)から実際の jar ファイルの URL を抽出します。
      パラメーター:
      jarUrl - 元の URL
      戻り値:
      実際の jar ファイルの URL
      例外:
      MalformedURLExceptionSE - 有効な jar ファイルの URL を抽出できなかった場合
      関連事項:
    • extractArchiveURL

      public static URLSE extractArchiveURL(URLSE jarUrl) throws MalformedURLExceptionSE
      指定された jar/war URL(jar ファイル内のリソースまたは jar ファイル自体を指す場合があります)から最も外側のアーカイブの URL を抽出します。

      war ファイル内にネストされた jar ファイルの場合、これは war ファイルへの URL を返します。これは、ファイルシステムで解決可能なファイルであるためです。

      パラメーター:
      jarUrl - 元の URL
      戻り値:
      実際の jar ファイルの URL
      例外:
      MalformedURLExceptionSE - 有効な jar ファイルの URL を抽出できなかった場合
      導入:
      4.1.8
      関連事項:
    • toURI

      public static URISE toURI(URLSE url) throws URISyntaxExceptionSE
      最初にスペースを "%20" URI エンコーディングに置き換えて、指定された URL の URI インスタンスを作成します。
      パラメーター:
      url - URI インスタンスに変換する URL
      戻り値:
      URI インスタンス
      例外:
      URISyntaxExceptionSE - URL が有効な URI ではなかった場合
      関連事項:
    • toURI

      public static URISE toURI(StringSE location) throws URISyntaxExceptionSE
      最初にスペースを "%20" URI エンコーディングに置き換えて、指定されたロケーション文字列の URI インスタンスを作成します。
      パラメーター:
      location - URI インスタンスに変換する場所の文字列
      戻り値:
      URI インスタンス
      例外:
      URISyntaxExceptionSE - 場所が有効な URI ではなかった場合
      関連事項:
    • toURL

      public static URLSE toURL(StringSE location) throws MalformedURLExceptionSE
      URI の構築と URL 変換を経て、指定された場所の文字列のクリーンな URL インスタンスを作成します。
      パラメーター:
      location - URL インスタンスに変換する場所の文字列
      戻り値:
      URL インスタンス
      例外:
      MalformedURLExceptionSE - 場所が有効な URL ではなかった場合
      導入:
      6.0
      関連事項:
    • toRelativeURL

      public static URLSE toRelativeURL(URLSE root, StringSE relativePath) throws MalformedURLExceptionSE
      URI の構築と URL 変換を経て、指定されたルート URL と相対パスのクリーンな URL インスタンスを作成します。
      パラメーター:
      root - 開始するルート URL
      relativePath - 適用する相対パス
      戻り値:
      相対 URL インスタンス
      例外:
      MalformedURLExceptionSE - 最終結果が有効な URL でない場合
      導入:
      6.0
      関連事項:
    • useCachesIfNecessary

      public static void useCachesIfNecessary(URLConnectionSE con)
      指定された接続に "useCaches"SE フラグを設定します。false を優先しますが、フラグを jar リソースの JVM デフォルト値 (通常は true) のままにします。
      パラメーター:
      con - フラグを設定する URLConnection
      関連事項: