nablarch.core.util

クラス FilePathSetting

java.lang.Object

nablarch.core.util.FilePathSetting

@Published(tag="architect")
public class FilePathSetting
extends java.lang.Object

ベースパスの論理名と物理パスとの対応を管理するクラス。

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
FilePathSetting()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
FilePathSetting	addBasePathSetting(java.lang.String basePathName, java.lang.String path) ベースパスの設定を追加する。
FilePathSetting	addFileExtensions(java.lang.String name, java.lang.String extension) ベースパスの論理名に対応する拡張子を追加する。
java.io.File	getBaseDirectory(java.lang.String basePathName) ベースディレクトリを取得する。
java.util.Map<java.lang.String,java.net.URL>	getBasePathSettings() ベースパスの論理名と物理パスとの対応を収めたMapを取得する。
java.net.URL	getBasePathUrl(java.lang.String basePathName) ベースパスのURLを取得する。
java.io.File	getFile(java.lang.String basePathName, java.lang.String fileName) 指定されたベースパスの直下に存在するファイルの抽象パスを取得する。
java.util.Map<java.lang.String,java.lang.String>	getFileExtensions() ベースパスの論理名と拡張子との対応を収めたMapを取得する。
java.io.File	getFileIfExists(java.lang.String basePathName, java.lang.String fileName) 指定されたベースパスの直下に存在するファイルの抽象パスを取得する。
protected java.lang.String	getFileNameJoinExtension(java.lang.String basePathName, java.lang.String fileName) ベースパスの論理名に対応する拡張子が存在する場合、ファイル名と拡張子を結合した文字列を返却する。
java.io.File	getFileWithoutCreate(java.lang.String basePathName, java.lang.String fileName) 指定されたベースパスの直下に存在するファイルの抽象パスを取得する。
static FilePathSetting	getInstance() このクラスのインスタンスをリポジトリより取得する。
protected java.io.File	resolvePath(java.lang.String basePathName, java.lang.String fileName, boolean createNew) 指定されたベースパスの直下に存在するファイルの抽象パスを作成して返却する。
FilePathSetting	setBasePathSettings(java.util.Map<java.lang.String,java.lang.String> basePathSettings) ベースパスの論理名と物理パスとの対応を収めたMapを設定する。
void	setFileExtensions(java.util.Map<java.lang.String,java.lang.String> fileExtensions) ベースパスの論理名と拡張子との対応を収めたMapを設定する。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

FilePathSetting

public FilePathSetting()

メソッドの詳細

getInstance

public static FilePathSetting getInstance()

このクラスのインスタンスをリポジトリより取得する。 リポジトリにインスタンスが存在しない場合は、デフォルトの設定で生成したこのクラスのインスタンスを返却する。

戻り値:

このクラスのインスタンス

getFile

public java.io.File getFile(java.lang.String basePathName,
                            java.lang.String fileName)
                     throws java.lang.IllegalArgumentException

指定されたベースパスの直下に存在するファイルの抽象パスを取得する。 ファイルが存在しない場合は新たにファイルを作成してその抽象パスを返却する。

パラメータ:

basePathName - ベースパスの論理名

fileName - 取得するファイル名

戻り値:

抽象パス

例外:

java.lang.IllegalArgumentException - 指定されたベースパス論理名に対応する物理パスが 設定されていない場合

getFileIfExists

public java.io.File getFileIfExists(java.lang.String basePathName,
                                    java.lang.String fileName)
                             throws java.lang.IllegalArgumentException

指定されたベースパスの直下に存在するファイルの抽象パスを取得する。 その抽象パスを返却する。ファイルが存在しない場合はnullを返却する。

パラメータ:

basePathName - ベースパスの論理名

fileName - 取得するファイル名

戻り値:

抽象パス

例外:

java.lang.IllegalArgumentException - 指定されたベースパス論理名に対応する物理パスが 設定されていない場合

getFileWithoutCreate

public java.io.File getFileWithoutCreate(java.lang.String basePathName,
                                         java.lang.String fileName)
                                  throws java.lang.IllegalArgumentException

指定されたベースパスの直下に存在するファイルの抽象パスを取得する。

パラメータ:

basePathName - ベースパスの論理名

fileName - 取得するファイル名

戻り値:

抽象パス

例外:

java.lang.IllegalArgumentException - 指定されたベースパス論理名に対応する物理パスが 設定されていない場合

resolvePath

protected java.io.File resolvePath(java.lang.String basePathName,
                                   java.lang.String fileName,
                                   boolean createNew)
                            throws java.lang.IllegalArgumentException

指定されたベースパスの直下に存在するファイルの抽象パスを作成して返却する。

パラメータ:

basePathName - ベースパスの論理名

fileName - 取得するファイル名

createNew - 指定したファイルが存在しない場合に新規ファイルを 作成するかどうか。（作成する場合はtrue）

戻り値:

抽象パス

例外:

java.lang.IllegalArgumentException - 指定されたベースパス論理名に対応する物理パスが 設定されていない場合

getBasePathUrl

public java.net.URL getBasePathUrl(java.lang.String basePathName)

ベースパスのURLを取得する。

パラメータ:

basePathName - ベースパスの論理名

戻り値:

URL

getBaseDirectory

public java.io.File getBaseDirectory(java.lang.String basePathName)

ベースディレクトリを取得する。

パラメータ:

basePathName - ベースパスの論理名

戻り値:

ベースディレクトリ

getFileNameJoinExtension

protected java.lang.String getFileNameJoinExtension(java.lang.String basePathName,
                                                    java.lang.String fileName)

ベースパスの論理名に対応する拡張子が存在する場合、ファイル名と拡張子を結合した文字列を返却する。 対応する拡張子が存在しない場合は、引数のファイル名をそのまま返却する。

パラメータ:

basePathName - ベースパスの論理名

fileName - ファイル名

戻り値:

ファイル名と拡張子を結合した文字列

setBasePathSettings

public FilePathSetting setBasePathSettings(java.util.Map<java.lang.String,java.lang.String> basePathSettings)

ベースパスの論理名と物理パスとの対応を収めたMapを設定する。

パラメータ:

basePathSettings - ベースパスの論理名と物理パス（URLで指定）との対応を収めたMap

戻り値:

このクラス自体のインスタンス

addBasePathSetting

public FilePathSetting addBasePathSetting(java.lang.String basePathName,
                                          java.lang.String path)

ベースパスの設定を追加する。

ベースパスにはディレクトリのみ指定できる。ディレクトリでない場合、例外をスローする。

ベースパスはURLで指定すること。URLを使用して、ファイルシステムとクラスパス上のリソースを指定することができる。
URLのフォーマットは下記の通りである。

     <スキーム名>:<リソースのパス>

     スキーム名:
         ファイルパスの場合 "file"
         クラスパスの場合 "classpath"
 

URLの指定例を下記に示す。

     ファイルパスの場合
         "file:./main/format"

     クラスパスの場合
         "classpath:web/format"
 

ベースパスにクラスパスを指定する場合、そのパスにはディレクトリが存在している必要がある。ディレクトリが存在しない場合は、例外をスローする。

ベースパスにファイルパスを指定する場合、そのパスにディレクトリが存在していなければ、本メソッド内でディレクトリを作成する。

パラメータ:

basePathName - ベースパスの論理名

path - ベースパス（URLで指定）

戻り値:

このクラス自体のインスタンス

addFileExtensions

public FilePathSetting addFileExtensions(java.lang.String name,
                                         java.lang.String extension)

ベースパスの論理名に対応する拡張子を追加する。

パラメータ:

name - ベースパスの論理名

extension - ベースパスの論理名に対応する拡張子

戻り値:

このクラス自体のインスタンス

getBasePathSettings

public java.util.Map<java.lang.String,java.net.URL> getBasePathSettings()

ベースパスの論理名と物理パスとの対応を収めたMapを取得する。

戻り値:

ベースパスの論理名と物理パスとの対応を収めたMap

getFileExtensions

public java.util.Map<java.lang.String,java.lang.String> getFileExtensions()

ベースパスの論理名と拡張子との対応を収めたMapを取得する。

戻り値:

ベースパスの論理名とデフォルト拡張子との対応を収めたMap

setFileExtensions

public void setFileExtensions(java.util.Map<java.lang.String,java.lang.String> fileExtensions)

ベースパスの論理名と拡張子との対応を収めたMapを設定する。

パラメータ:

fileExtensions - ベースパスの論理名とデフォルト拡張子との対応を収めたMap