Package nablarch.core.util
Class FilePathSetting
java.lang.Object
nablarch.core.util.FilePathSetting
ベースパスの論理名と物理パスとの対応を管理するクラス。
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddBasePathSetting
(String basePathName, String path) ベースパスの設定を追加する。addFileExtensions
(String name, String extension) ベースパスの論理名に対応する拡張子を追加する。getBaseDirectory
(String basePathName) ベースディレクトリを取得する。ベースパスの論理名と物理パスとの対応を収めたMapを取得する。getBasePathUrl
(String basePathName) ベースパスのURLを取得する。指定されたベースパスの直下に存在するファイルの抽象パスを取得する。 ファイルが存在しない場合は新たにファイルを作成してその抽象パスを返却する。ベースパスの論理名と拡張子との対応を収めたMapを取得する。getFileIfExists
(String basePathName, String fileName) 指定されたベースパスの直下に存在するファイルの抽象パスを取得する。 その抽象パスを返却する。ファイルが存在しない場合はnullを返却する。protected String
getFileNameJoinExtension
(String basePathName, String fileName) ベースパスの論理名に対応する拡張子が存在する場合、ファイル名と拡張子を結合した文字列を返却する。 対応する拡張子が存在しない場合は、引数のファイル名をそのまま返却する。getFileWithoutCreate
(String basePathName, String fileName) 指定されたベースパスの直下に存在するファイルの抽象パスを取得する。static FilePathSetting
このクラスのインスタンスをリポジトリより取得する。 リポジトリにインスタンスが存在しない場合は、デフォルトの設定で生成したこのクラスのインスタンスを返却する。protected File
resolvePath
(String basePathName, String fileName, boolean createNew) 指定されたベースパスの直下に存在するファイルの抽象パスを作成して返却する。setBasePathSettings
(Map<String, String> basePathSettings) ベースパスの論理名と物理パスとの対応を収めたMapを設定する。void
setFileExtensions
(Map<String, String> fileExtensions) ベースパスの論理名と拡張子との対応を収めたMapを設定する。
-
Constructor Details
-
FilePathSetting
public FilePathSetting()
-
-
Method Details
-
getInstance
このクラスのインスタンスをリポジトリより取得する。 リポジトリにインスタンスが存在しない場合は、デフォルトの設定で生成したこのクラスのインスタンスを返却する。- Returns:
- このクラスのインスタンス
-
getFile
指定されたベースパスの直下に存在するファイルの抽象パスを取得する。 ファイルが存在しない場合は新たにファイルを作成してその抽象パスを返却する。- Parameters:
basePathName
- ベースパスの論理名fileName
- 取得するファイル名- Returns:
- 抽象パス
- Throws:
IllegalArgumentException
- 指定されたベースパス論理名に対応する物理パスが 設定されていない場合
-
getFileIfExists
指定されたベースパスの直下に存在するファイルの抽象パスを取得する。 その抽象パスを返却する。ファイルが存在しない場合はnullを返却する。- Parameters:
basePathName
- ベースパスの論理名fileName
- 取得するファイル名- Returns:
- 抽象パス
- Throws:
IllegalArgumentException
- 指定されたベースパス論理名に対応する物理パスが 設定されていない場合
-
getFileWithoutCreate
public File getFileWithoutCreate(String basePathName, String fileName) throws IllegalArgumentException 指定されたベースパスの直下に存在するファイルの抽象パスを取得する。- Parameters:
basePathName
- ベースパスの論理名fileName
- 取得するファイル名- Returns:
- 抽象パス
- Throws:
IllegalArgumentException
- 指定されたベースパス論理名に対応する物理パスが 設定されていない場合
-
resolvePath
protected File resolvePath(String basePathName, String fileName, boolean createNew) throws IllegalArgumentException 指定されたベースパスの直下に存在するファイルの抽象パスを作成して返却する。- Parameters:
basePathName
- ベースパスの論理名fileName
- 取得するファイル名createNew
- 指定したファイルが存在しない場合に新規ファイルを 作成するかどうか。(作成する場合はtrue)- Returns:
- 抽象パス
- Throws:
IllegalArgumentException
- 指定されたベースパス論理名に対応する物理パスが 設定されていない場合
-
getBasePathUrl
ベースパスのURLを取得する。- Parameters:
basePathName
- ベースパスの論理名- Returns:
- URL
-
getBaseDirectory
ベースディレクトリを取得する。- Parameters:
basePathName
- ベースパスの論理名- Returns:
- ベースディレクトリ
-
getFileNameJoinExtension
ベースパスの論理名に対応する拡張子が存在する場合、ファイル名と拡張子を結合した文字列を返却する。 対応する拡張子が存在しない場合は、引数のファイル名をそのまま返却する。- Parameters:
basePathName
- ベースパスの論理名fileName
- ファイル名- Returns:
- ファイル名と拡張子を結合した文字列
-
setBasePathSettings
ベースパスの論理名と物理パスとの対応を収めたMapを設定する。- Parameters:
basePathSettings
- ベースパスの論理名と物理パス(URLで指定)との対応を収めたMap- Returns:
- このクラス自体のインスタンス
-
addBasePathSetting
ベースパスの設定を追加する。 ベースパスにはディレクトリのみ指定できる。ディレクトリでない場合、例外をスローする。 ベースパスはURLで指定すること。URLを使用して、ファイルシステムとクラスパス上のリソースを指定することができる。
URLのフォーマットは下記の通りである。<スキーム名>:<リソースのパス> スキーム名: ファイルパスの場合 "file" クラスパスの場合 "classpath"
URLの指定例を下記に示す。
ファイルパスの場合 "file:./main/format" クラスパスの場合 "classpath:web/format"
ベースパスにクラスパスを指定する場合、そのパスにはディレクトリが存在している必要がある。ディレクトリが存在しない場合は、例外をスローする。 ベースパスにファイルパスを指定する場合、そのパスにディレクトリが存在していなければ、本メソッド内でディレクトリを作成する。- Parameters:
basePathName
- ベースパスの論理名path
- ベースパス(URLで指定)- Returns:
- このクラス自体のインスタンス
-
addFileExtensions
ベースパスの論理名に対応する拡張子を追加する。- Parameters:
name
- ベースパスの論理名extension
- ベースパスの論理名に対応する拡張子- Returns:
- このクラス自体のインスタンス
-
getBasePathSettings
ベースパスの論理名と物理パスとの対応を収めたMapを取得する。- Returns:
- ベースパスの論理名と物理パスとの対応を収めたMap
-
getFileExtensions
ベースパスの論理名と拡張子との対応を収めたMapを取得する。- Returns:
- ベースパスの論理名とデフォルト拡張子との対応を収めたMap
-
setFileExtensions
ベースパスの論理名と拡張子との対応を収めたMapを設定する。- Parameters:
fileExtensions
- ベースパスの論理名とデフォルト拡張子との対応を収めたMap
-