jp.go.aist.dmrc.platform.beans.io
クラス PFFile

java.lang.Object
  拡張jp.go.aist.dmrc.platform.beans.io.PFFile
すべての実装インタフェース:
PFComponent, PFXMLSerializable, java.io.Serializable

public class PFFile
extends java.lang.Object
implements PFComponent, PFXMLSerializable

ファイル情報取得ユーティリティコンポーネント。

関連項目:
直列化された形式

コンストラクタの概要
PFFile()
          コンストラクタ。
 
メソッドの概要
 PFObjectTree addAllDirectoriesTree(PFObjectTree target)
          ツリーを取得して、指定パス配下のツリーをルートノードの配下に作成します。
 void addSubDirectoriesTree(PFObjectTreeNode parent, java.lang.String temp)
          引数のノード直下の、指定のディレクトリ・ファイルノードを設定します。
 boolean canRead()
          設定されているファイルが読込可能かどうかを返す。
 boolean canWrite()
          設定されているファイルが書込可能かどうかを返す。
 boolean cleanAllDirectoriesOnExit()
          VM終了時にパス名が示すディレクトリ配下に存在する全ファイルを削除します。
 boolean cleanAllDirectries()
          パス名が示すディレクトリ配下に存在する全ファイルを削除します。
 boolean cleanDirectory()
          パス名が示すディレクトリ直下に存在する全ファイルを削除します。
 boolean cleanDirectoryOnExit()
          VM終了時にパス名が示すディレクトリ直下に存在する全ファイルを削除します。
 boolean contentEquals(java.lang.String dest)
          パスの示すファイルと、指定のファイルの中身を比較します。
 boolean copyDir(java.lang.String dest)
          パス名が示すディレクトリを指定ディレクトリへコピーします。
 boolean copyFile(java.lang.String dest)
          パス名が示すファイルを指定ディレクトリへコピーします。
 boolean copyFileReserve(java.lang.String dest)
          パス名が示すファイルを指定パスへコピーします。
 boolean createNewFile()
          パス名が示すファイルを新規に生成します。
 boolean createNewFile(java.lang.String dest)
           
 boolean delete()
          パス名が示すファイルまたはディレクトリを削除します。
 void deleteOnExit()
          VM終了時にパス名が示すファイルまたはディレクトリを削除します。
 boolean exists()
          設定されているファイルが存在するかどうかを返す。
 boolean forceDeleteDirectories()
          パス名が示すディレクトリ配下のファイル・ディレクトリを全て削除します。
 boolean forceDeleteDirectoriesOnExit()
          VM終了時にパス名が示すディレクトリ配下のファイル・ディレクトリを全て削除します。
 java.lang.String getAbsolutePath()
          設定されているファイルの絶対パスでのファイル名を返す。
 java.lang.String getAbsolutePathWithSpecifiedSeparator()
          設定されているファイルの絶対パスでのファイル名を、設定されている区切り文字 を使用して表し、その文字列を返す。
 java.lang.String getAbsolutePathWithSpecifiedSeparator(java.lang.String delim)
          設定されているファイルの絶対パスでのファイル名を、区切り文字を指定して 表現し、その文字列を返す。
 PFObjectTree getAllContentsTree()
          パス名が示すディレクトリの下位に存在する全コンテンツのツリーを取得します。
 PFObjectList getAllDirectories()
          パス名が示すディレクトリの下位に存在する全ディレクトリを取得します。
 PFObjectTree getAllDirectoriesTree()
          パス名が示すディレクトリの下位に存在する全ディレクトリツリーを取得します。
 PFObjectTree getAllDirectoriesTreeMulti()
          パス名が示すディレクトリの下位に存在する全ディレクトリツリーを取得します。
 PFObjectTree getAllDirectoriesTreeMulti(PFObjectList files)
          ファイルを取得して、その数分のツリーを作成します。
 PFObjectTree getAllDirectoriesTreeMultiNames(PFObjectList names)
          ファイルパス名を取得して、その数分のツリーを作成します。
 PFObjectList getAllDirectoryNames()
          パス名が示すディレクトリの下位に存在する全ディレクトリ名称を取得します。
 PFObjectList getAllFileNames()
          パス名が示すディレクトリ配下のファイルを示す抽象パス名の配列を返します。
 PFObjectList getAllFiles()
          パス名が示すディレクトリ配下のファイルを示す抽象パス名の配列を返します。
 int getBufferSize()
          コピー・移動時のバッファサイズ取得。
 int getComponentID()
          コンポーネントIDを取得する。
 java.lang.String getComponentKey()
          コンポーネントキーを取得する。
 PFMultiLocaleString getComponentKeys()
          全ロケール分のコンポーネントキーを返す。
 java.lang.String getComponentName()
          コンポーネント名称を取得する。
 java.lang.String getComponentPublicName()
          コンポーネント公開名を取得する.
 java.lang.String getComponentString()
          コンポーネントの文字列表現を取得する。
 long getDirectoryLength()
          パスの示すディレクトリのサイズを返します。
 java.lang.String getExtension()
          拡張子を返す。
 java.io.File getFile()
          ファイルオブジェクトを返す。
 java.util.Date getLastModified()
          設定されているファイルの最終更新日を返す。
 long getLength()
          設定されているファイルのサイズを返す。
 PFObjectList getList()
          設定されているディレクトリに含まれるファイルの一覧を返す。
 java.lang.String getName()
          設定されているファイルのファイル名を返す。
 PFObjectList getNameList()
          パス名が示すディレクトリにあるファイルおよびディレクトリを示す 文字列の配列を返す。
 java.lang.String getParent()
          設定されているファイルが属しているディレクトリの名前を返す。
 java.lang.String getPathSeparator()
          推奨されていません。  
 PFObjectList getRootNames()
          有効なファイルシステムのルートをリスト表示返します。
 PFObjectList getRoots()
          有効なファイルシステムのルートをリスト表示返します。
 java.lang.String getSeparator()
          パス名で使用する区切り文字を取得。
 PFObjectTree getSubContentsTree()
          パス名が示すディレクトリの直下に存在する全コンテンツのツリーを取得します。
 PFObjectList getSubDirectories()
          パス名が示すディレクトリの直下にあるサブフォルダを取得します。
 PFObjectTreeNode getSubDirectoriesNode(java.lang.String temp)
          指定のディレクトリ・ファイルノードを取得します。
 PFObjectList getSubDirectoriesNodeList()
          パス名が示すディレクトリの直下に存在する全ディレクトリのノードをリストで取得します。
 PFObjectList getSubDirectoriesNodeList(java.lang.String temp)
          パス名が示すディレクトリの直下に存在する全ディレクトリのノードをリストで取得します。
 PFObjectList getSubDirectoryNames()
          パス名が示すディレクトリの直下にあるディレクトリを取得します。
 PFObjectList getSubFileNames()
          パス名が示すディレクトリ内のファイルを示す抽象パス名の配列を返します。
 PFObjectList getSubFiles()
          パス名が示すディレクトリ内のファイルを示す抽象パス名の配列を返します。
 boolean isAllowPullTransfer()
          他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.
 boolean isAllowPushTransfer()
          他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.
 boolean isAllowRemoteInvocation()
          他PFからのコンポーネント連携要求に対する可否属性を取得する.
 boolean isDirectory()
          設定されているファイルがディレクトリかどうかを返す。
 boolean isFile()
          設定されているファイルが普通のファイルかどうかを返す。
 boolean isHidden()
          設定されているファイルが隠しファイルかどうかを返す。
 void localeUpdated()
          ロケール更新への対応を行う。
 boolean mkdir()
          パス名が示すディレクトリを生成します。
 boolean mkdir(java.lang.String dest)
           
 boolean mkdirs()
          パス名が示すディレクトリを生成します。
 boolean moveDir(java.lang.String dest)
          パス名が示すディレクトリを指定ディレクトリへ移動します。
 boolean moveFile(java.lang.String dest)
          パス名が示すファイルを指定ディレクトリへ移動します。
 boolean moveFileReserve(java.lang.String dest)
          パス名が示すファイルを指定ディレクトリへ移動します。
 void readXML(PFXMLLoader in)
          コンポーネントのXML入力.
 PFObjectTree refreshDirectoriesTree(PFObjectTree target)
          ツリーを取得して、ルートノード配下を全てリフレッシュします。
 PFObjectTree refreshSubDirectoriesTree(PFObjectTree target, int depth)
          ツリーを取得して、指定の階層配下を全てリフレッシュします。
 boolean renameTo(java.lang.String dest)
          パス名が示すファイルの名前を変更します。
 void setAllowPullTransfer(boolean flag)
          他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.
 void setAllowPushTransfer(boolean flag)
          他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.
 void setAllowRemoteInvocation(boolean flag)
          他PFからのコンポーネント連携要求に対する可否属性を設定する.
 boolean setBufferSize(java.lang.String size)
          コピー・移動時のバッファサイズ設定。
 void setComponentID(int id)
          コンポーネントIDを設定する。
 void setComponentKey(java.lang.String key)
          コンポーネントキーを設定する。
 void setComponentKeys(PFMultiLocaleString keys)
          全ロケール分のコンポーネントキーを設定する。
 void setComponentPublicName(java.lang.String publicName)
          コンポーネント公開名を設定する.
 void setFile(java.io.File file)
          ファイル名を設定する。
 void setFile(java.io.File parent, java.lang.String child)
          ファイル名を設定する。
 void setFile(java.lang.String pathname)
          ファイル名を設定する。
 void setFile(java.lang.String parent, java.lang.String child)
          ファイル名を設定する。
 boolean setLastModified(long time)
          この抽象パス名が示すファイルまたはディレクトリが変更された 時刻を設定します。
 void setPathSeparator(java.lang.String delim)
          推奨されていません。  
 boolean setReadOnly()
          この抽象パス名が示すファイルまたはディレクトリにマークを設定し、 読み込みオペレーションだけが許可されるようにします。
 void setRootNodeName(java.lang.String nodeName)
          ツリーを作成するさいのルートノードの名称。
 void setSeparator(java.lang.String delim)
          パス名で使用する区切り文字を設定。
 void writeXML(PFXMLGenerator out)
          コンポーネントのXML出力.
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

PFFile

public PFFile()
コンストラクタ。

メソッドの詳細

getComponentName

public java.lang.String getComponentName()
コンポーネント名称を取得する。

定義:
インタフェース PFComponent 内の getComponentName
戻り値:
コンポーネント名

getComponentKey

public java.lang.String getComponentKey()
コンポーネントキーを取得する。

定義:
インタフェース PFComponent 内の getComponentKey
戻り値:
コンポーネントキー文字列

setComponentKey

public void setComponentKey(java.lang.String key)
コンポーネントキーを設定する。

定義:
インタフェース PFComponent 内の setComponentKey
パラメータ:
key - コンポーネントキー

getComponentKeys

public PFMultiLocaleString getComponentKeys()
全ロケール分のコンポーネントキーを返す。

戻り値:
全ロケール分のコンポーネントキー

setComponentKeys

public void setComponentKeys(PFMultiLocaleString keys)
全ロケール分のコンポーネントキーを設定する。

パラメータ:
keys - 全ロケール分のコンポーネントキー

getComponentID

public int getComponentID()
コンポーネントIDを取得する。

定義:
インタフェース PFComponent 内の getComponentID
戻り値:
コンポーネントID

setComponentID

public void setComponentID(int id)
コンポーネントIDを設定する。
コンポーネントIDはプラットフォームPFComponentBusから設定される。 各コンポーネント内では操作しないこと。

定義:
インタフェース PFComponent 内の setComponentID
パラメータ:
id - 設定するコンポーネントID

getComponentString

public java.lang.String getComponentString()
コンポーネントの文字列表現を取得する。
形式:"Component Name" [ ID : "ID" ]

定義:
インタフェース PFComponent 内の getComponentString
戻り値:
文字列表現

getComponentPublicName

public java.lang.String getComponentPublicName()
コンポーネント公開名を取得する.

定義:
インタフェース PFComponent 内の getComponentPublicName
戻り値:
コンポーネント公開名

setComponentPublicName

public void setComponentPublicName(java.lang.String publicName)
                            throws PFComponentException
コンポーネント公開名を設定する.
空文字のみの公開名は、nullに置き換える。数字のみの公開名は許可しない。 また、既存コンポーネントとの重複も認めない.

定義:
インタフェース PFComponent 内の setComponentPublicName
パラメータ:
publicName - 設定するコンポーネント公開名
例外:
PFComponentException - 規約に反する名前が設定されようとした場合

isAllowRemoteInvocation

public boolean isAllowRemoteInvocation()
他PFからのコンポーネント連携要求に対する可否属性を取得する.

定義:
インタフェース PFComponent 内の isAllowRemoteInvocation
戻り値:
コンポーネント連携要求可否属性

setAllowRemoteInvocation

public void setAllowRemoteInvocation(boolean flag)
他PFからのコンポーネント連携要求に対する可否属性を設定する.

定義:
インタフェース PFComponent 内の setAllowRemoteInvocation
パラメータ:
flag - コンポーネント連携要求に対する可否

isAllowPullTransfer

public boolean isAllowPullTransfer()
他PFからのPull型コンポーネント転送要求に対する可否属性を取得する.

定義:
インタフェース PFComponent 内の isAllowPullTransfer
戻り値:
Pull型コンポーネント転送要求可否属性

setAllowPullTransfer

public void setAllowPullTransfer(boolean flag)
他PFからのPull型コンポーネント転送要求に対する可否属性を設定する.

定義:
インタフェース PFComponent 内の setAllowPullTransfer
パラメータ:
flag - Pull型コンポーネント転送要求に対する可否

isAllowPushTransfer

public boolean isAllowPushTransfer()
他PFへのPush型コンポーネント転送要求に対する可否属性を取得する.

定義:
インタフェース PFComponent 内の isAllowPushTransfer
戻り値:
Push型コンポーネント転送要求可否属性

setAllowPushTransfer

public void setAllowPushTransfer(boolean flag)
他PFへのPush型コンポーネント転送要求に対する可否属性を設定する.

定義:
インタフェース PFComponent 内の setAllowPushTransfer
パラメータ:
flag - Push型コンポーネント転送要求に対する可否

localeUpdated

public void localeUpdated()
ロケール更新への対応を行う。

定義:
インタフェース PFComponent 内の localeUpdated

getFile

public java.io.File getFile()
                     throws PFComponentException
ファイルオブジェクトを返す。

戻り値:
ファイルオブジェクト
例外:
PFComponentException

setFile

public void setFile(java.io.File parent,
                    java.lang.String child)
ファイル名を設定する。

パラメータ:
parent - ディレクトリ
child - ファイル名

setFile

public void setFile(java.io.File file)
ファイル名を設定する。

パラメータ:
file - ファイルオブジェクト

setFile

public void setFile(java.lang.String pathname)
ファイル名を設定する。

パラメータ:
pathname - 絶対パスのファイル名

setFile

public void setFile(java.lang.String parent,
                    java.lang.String child)
ファイル名を設定する。

パラメータ:
parent - 絶対パスのディレクトリ名
child - ファイル名

canRead

public boolean canRead()
                throws PFComponentException
設定されているファイルが読込可能かどうかを返す。

戻り値:
読込可否
例外:
PFComponentException - ファイルが設定されていない場合

canWrite

public boolean canWrite()
                 throws PFComponentException
設定されているファイルが書込可能かどうかを返す。

戻り値:
書込可否
例外:
PFComponentException - ファイルが設定されていない場合

exists

public boolean exists()
               throws PFComponentException
設定されているファイルが存在するかどうかを返す。

戻り値:
存在有無
例外:
PFComponentException - ファイルが設定されていない場合

isDirectory

public boolean isDirectory()
                    throws PFComponentException
設定されているファイルがディレクトリかどうかを返す。

戻り値:
ディレクトリの有無
例外:
PFComponentException - ファイルが設定されていない場合

isFile

public boolean isFile()
               throws PFComponentException
設定されているファイルが普通のファイルかどうかを返す。

戻り値:
ファイルの有無
例外:
PFComponentException - ファイルが設定されていない場合

isHidden

public boolean isHidden()
                 throws PFComponentException
設定されているファイルが隠しファイルかどうかを返す。

戻り値:
隠しファイルの有無
例外:
PFComponentException - ファイルが設定されていない場合

getLastModified

public java.util.Date getLastModified()
                               throws PFComponentException
設定されているファイルの最終更新日を返す。

戻り値:
最終更新日
例外:
PFComponentException - ファイルが設定されていない場合

getLength

public long getLength()
               throws PFComponentException
設定されているファイルのサイズを返す。

戻り値:
ファイルサイズ
例外:
PFComponentException - ファイルが設定されていない場合

getList

public PFObjectList getList()
                     throws PFComponentException
設定されているディレクトリに含まれるファイルの一覧を返す。

戻り値:
ファイル一覧
例外:
PFComponentException - ファイルが設定されていない場合

getName

public java.lang.String getName()
                         throws PFComponentException
設定されているファイルのファイル名を返す。

戻り値:
ファイル名
例外:
PFComponentException - ファイルが設定されていない場合

getParent

public java.lang.String getParent()
                           throws PFComponentException
設定されているファイルが属しているディレクトリの名前を返す。

戻り値:
ディレクトリ名
例外:
PFComponentException - ファイルが設定されていない場合

getAbsolutePath

public java.lang.String getAbsolutePath()
                                 throws PFComponentException
設定されているファイルの絶対パスでのファイル名を返す。

戻り値:
絶対パスのファイル名
例外:
PFComponentException - ファイルが設定されていない場合

getAbsolutePathWithSpecifiedSeparator

public java.lang.String getAbsolutePathWithSpecifiedSeparator()
                                                       throws PFComponentException
設定されているファイルの絶対パスでのファイル名を、設定されている区切り文字 を使用して表し、その文字列を返す。

戻り値:
設定されている区切り文字を使用した絶対パスのファイル名
例外:
PFComponentException - ファイルが設定されていない場合

getAbsolutePathWithSpecifiedSeparator

public java.lang.String getAbsolutePathWithSpecifiedSeparator(java.lang.String delim)
                                                       throws PFComponentException
設定されているファイルの絶対パスでのファイル名を、区切り文字を指定して 表現し、その文字列を返す。

パラメータ:
delim - 区切り文字
戻り値:
指定の区切り文字を使用した絶対パスのファイル名
例外:
PFComponentException - ファイルが設定されていない場合

getExtension

public java.lang.String getExtension()
                              throws PFComponentException
拡張子を返す。
拡張子がない場合は空文字列を返す。

戻り値:
拡張子
例外:
PFComponentException - ファイルが設定されていない場合

setBufferSize

public boolean setBufferSize(java.lang.String size)
コピー・移動時のバッファサイズ設定。

 注意事項
 0以下、数値以外の文字が設定されたの場合、設定をキャンセルします。
 なお、デフォルト値は1Mです。
 指定範囲はintの範囲です。
 

パラメータ:
size - - バッファサイズ。
戻り値:
処理ステータス。

getBufferSize

public int getBufferSize()
コピー・移動時のバッファサイズ取得。

 注意事項
 0以下、数値以外の文字が設定されたの場合、1Mに設定します。
 

戻り値:
バッファサイズ。

createNewFile

public boolean createNewFile()
                      throws PFComponentException
パス名が示すファイルを新規に生成します。

 注意事項
 示されたファイルがすでに存在する場合は生成しない。
 

戻り値:
処理ステータス。 指定されたファイルが存在せず、ファイルの生成に成功した場合は true、 示されたファイルがすでに存在する場合を含む、上記以外の場合は false 。
例外:
PFComponentException - ファイルが設定されていない場合。 ファイル作成失敗の場合。

createNewFile

public boolean createNewFile(java.lang.String dest)
                      throws PFComponentException
例外:
PFComponentException

mkdir

public boolean mkdir()
              throws PFComponentException
パス名が示すディレクトリを生成します。

 注意事項
 最下層のディレクトリのみ作成。
 存在した場合は上書きせず、生成しない。

 

戻り値:
処理ステータス。 ディレクトリが生成された場合は true、そうでない場合は false 。
例外:
PFComponentException - ディレクトリが設定されていない場合。 ディレクトリ作成失敗の場合。

mkdir

public boolean mkdir(java.lang.String dest)
              throws PFComponentException
例外:
PFComponentException

mkdirs

public boolean mkdirs()
               throws PFComponentException
パス名が示すディレクトリを生成します。

 注意事項
 存在していないが必要な親ディレクトリも一緒に作成されます。
 このオペレーションが失敗した場合でも、いくつかの	
 必要な親ディレクトリの生成には成功した場合があります	。

 

戻り値:
処理ステータス。 必要なすべての親ディレクトリを含めてディレクトリが 生成された場合は true、そうでない場合は false 。
例外:
PFComponentException - ディレクトリが設定されていない場合

delete

public boolean delete()
               throws PFComponentException
パス名が示すファイルまたはディレクトリを削除します。

 注意事項
 このパス名がディレクトリを示す場合、
 そのディレクトリが削除されるためには空である必要があります。

 

戻り値:
処理ステータス。 ファイルまたはディレクトリが正常に削除された場合は true、 そうでない場合は false
例外:
PFComponentException - ディレクトリが設定されていない場合

deleteOnExit

public void deleteOnExit()
                  throws PFComponentException
VM終了時にパス名が示すファイルまたはディレクトリを削除します。

 注意事項
 このパス名がディレクトリを示す場合、
 そのディレクトリが削除されるためには空である必要があります。
 削除がいったん要求されると、その要求は取り消せません。そのため、
 このメソッドの使用には注意が必要です。
 

戻り値:
処理ステータス。 ファイルまたはディレクトリが正常に削除された場合は true、 そうでない場合は false
例外:
PFComponentException - ディレクトリが設定されていない場合

getNameList

public PFObjectList getNameList()
                         throws PFComponentException
パス名が示すディレクトリにあるファイルおよびディレクトリを示す 文字列の配列を返す。

 注意事項
 この抽象パス名がディレクトリを示さない場合、このメソッドは null を返します。
 ディレクトリを示す場合は、文字列の配列が返されます。
 文字列は、ディレクトリ内の各ファイルまたはディレクトリごとに 1 つです。
 そのディレクトリ自体およびその親のディレクトリを示す名前は結果に含まれません。
 各文字列は、絶対パスではなくファイル名です。

 

戻り値:
ファイル、ディレクトリ名称一覧
例外:
PFComponentException - ファイルが設定されていない場合

setLastModified

public boolean setLastModified(long time)
                        throws PFComponentException
この抽象パス名が示すファイルまたはディレクトリが変更された 時刻を設定します。

 注意事項
 引数が0より小さい場合はfalse

 

パラメータ:
time - 最新に変更された時刻。 エポック (1970 年 1 月 1 日 0 時 0 分 0 秒、グリニッジ標準時) からミリ秒単位で測定
戻り値:
処理結果ステータス。 オペレーションが成功した場合は true、そうでない場合は false
例外:
PFComponentException - ファイルが設定されていない場合

setReadOnly

public boolean setReadOnly()
                    throws PFComponentException
この抽象パス名が示すファイルまたはディレクトリにマークを設定し、 読み込みオペレーションだけが許可されるようにします。 このメソッドを呼び出すと、ファイルまたはディレクトリはそれが削除されるか、 書き込みアクセスを許可するようにマークを設定するまで変更されません。 読み込み専用ファイルまたはディレクトリが削除できるかどうかは、背後のシステムに依存します。

 注意事項
 なし
s
 

戻り値:
処理結果ステータス。 オペレーションが成功した場合は true、そうでない場合は false
例外:
PFComponentException - ファイルが設定されていない場合

getRoots

public PFObjectList getRoots()
                      throws PFComponentException
有効なファイルシステムのルートをリスト表示返します。

 注意事項
 なし

 

戻り値:
有効なファイルシステムのルートを示す File オブジェクトの配列。 一連のルートが判別できない場合は null。 配列は、ファイルシステムのルートがない場合は空になる。
例外:
PFComponentException - ファイルが設定されていない場合

getRootNames

public PFObjectList getRootNames()
                          throws PFComponentException
有効なファイルシステムのルートをリスト表示返します。

 注意事項
 なし

 

戻り値:
有効なファイルシステムのルートを示す String オブジェクトの配列。 一連のルートが判別できない場合は null。 配列は、ファイルシステムのルートがない場合は空になる。
例外:
PFComponentException - ファイルが設定されていない場合

renameTo

public boolean renameTo(java.lang.String dest)
                 throws PFComponentException
パス名が示すファイルの名前を変更します。

 注意事項
 なし

 

パラメータ:
dest - - 指定されたファイルの新しい抽象パス名。
戻り値:
名前の変更が成功した場合は true、そうでない場合は false 。
例外:
PFComponentException - ファイルが設定されていない場合

getSubFiles

public PFObjectList getSubFiles()
                         throws PFComponentException
パス名が示すディレクトリ内のファイルを示す抽象パス名の配列を返します。

 注意事項
 指定ディレクトリの直下が対象です。配下ではありません。
 返却値にディレクトリは含みません。
 パス名がディレクトリを示さない場合、nullを返します。
 配下にファイルが存在しない場合は、空の配列を返します。

 

戻り値:
パス名が示すディレクトリ内のファイルを示す抽象パス名の配列。(File)
例外:
PFComponentException - ファイルが設定されていない場合

getSubFileNames

public PFObjectList getSubFileNames()
                             throws PFComponentException
パス名が示すディレクトリ内のファイルを示す抽象パス名の配列を返します。

 注意事項
 ディレクトリ直下が対象です。配下ではありません。
 返却値にディレクトリは含みません。
 パス名がディレクトリを示さない場合、nullを返します。
 配下にファイルが存在しない場合は、空の配列を返します。
 

戻り値:
パス名が示すディレクトリ内のファイルを示す抽象パス名の配列。(String)
例外:
PFComponentException - ファイルが設定されていない場合

getAllFiles

public PFObjectList getAllFiles()
                         throws PFComponentException
パス名が示すディレクトリ配下のファイルを示す抽象パス名の配列を返します。

 注意事項
 ディレクトリ配下が対象です。直下ではありません。
 返却値にディレクトリは含みません。
 パス名がディレクトリを示さない場合、nullを返します。
 配下にファイルが存在しない場合は、空の配列を返します。
 

戻り値:
パス名が示すディレクトリ配下のファイルを示す抽象パス名の配列。(File)
例外:
PFComponentException - ファイルが設定されていない場合

getAllFileNames

public PFObjectList getAllFileNames()
                             throws PFComponentException
パス名が示すディレクトリ配下のファイルを示す抽象パス名の配列を返します。

 注意事項
 ディレクトリ配下が対象です。直下ではありません。
 返却値にディレクトリは含みません。
 パス名がディレクトリを示さない場合、nullを返します。
 配下にファイルが存在しない場合は、空の配列を返します。
 

戻り値:
パス名が示すディレクトリ配下のファイルを示す抽象パス名の配列。(String)
例外:
PFComponentException - ファイルが設定されていない場合

getSubDirectories

public PFObjectList getSubDirectories()
                               throws PFComponentException
パス名が示すディレクトリの直下にあるサブフォルダを取得します。

 注意事項
 ディレクトリ直下が対象です。配下ではありません。
 返却値にファイルは含みません。
 パス名がディレクトリを示さない場合、nullを返します。
 配下にディレクトリが存在しない場合は、空の配列を返します。

 

戻り値:
パス名が示すディレクトリ内のディレクトリを示す抽象パス名の配列。(File)
例外:
PFComponentException - ファイルが設定されていない場合

getSubDirectoryNames

public PFObjectList getSubDirectoryNames()
                                  throws PFComponentException
パス名が示すディレクトリの直下にあるディレクトリを取得します。

 注意事項
 ディレクトリ直下が対象です。配下ではありません。
 返却値にファイルは含みません。
 パス名がディレクトリを示さない場合、nullを返します。
 配下にディレクトリが存在しない場合は、空の配列を返します。

 

戻り値:
パス名が示すディレクトリ内のディレクトリを示す抽象パス名の配列。(String)
例外:
PFComponentException - ファイルが設定されていない場合

getAllDirectories

public PFObjectList getAllDirectories()
                               throws PFComponentException
パス名が示すディレクトリの下位に存在する全ディレクトリを取得します。

 注意事項
 ディレクトリ配下が対象です。直下ではありません。
 返却値にファイルは含みません。
 パス名がディレクトリを示さない場合、nullを返します。
 配下にディレクトリが存在しない場合は、空の配列を返します。

 

戻り値:
パス名が示すディレクトリ配下のディレクトリを示す抽象パス名の配列。(File)
例外:
PFComponentException - ディレクトリが設定されていない場合 ディレクトリ作成失敗の場合。

getAllDirectoryNames

public PFObjectList getAllDirectoryNames()
                                  throws PFComponentException
パス名が示すディレクトリの下位に存在する全ディレクトリ名称を取得します。

 注意事項
 ディレクトリ配下が対象です。直下ではありません。
 返却値にファイルは含みません。
 パス名がディレクトリを示さない場合、nullを返します。
 配下にディレクトリが存在しない場合は、空の配列を返します。

 

戻り値:
パス名が示すディレクトリ配下のディレクトリを示す抽象パス名の配列。(String)
例外:
PFComponentException - ディレクトリが設定されていない場合 ディレクトリ作成失敗の場合。

cleanDirectory

public boolean cleanDirectory()
                       throws PFComponentException
パス名が示すディレクトリ直下に存在する全ファイルを削除します。

 注意事項
 このパス名がディレクトリの直下のファイルのみであり、
 配下全てのファイルが対象ではありません。
 このオペレーションが失敗した場合でも、いくつかの	
 必要ファイルの削除は成功した場合があります	。

 

戻り値:
処理結果ステータス。 必要なすべてファイルが削除された場合は true、 そうでない場合は false 。
例外:
PFComponentException - ディレクトリが設定されていない場合

cleanDirectoryOnExit

public boolean cleanDirectoryOnExit()
                             throws PFComponentException
VM終了時にパス名が示すディレクトリ直下に存在する全ファイルを削除します。

 注意事項
 このパス名がディレクトリの直下のファイルのみであり、
 配下全てのファイルが対象ではありません。
 このオペレーションが失敗した場合でも、いくつかの	
 必要ファイルの削除は成功した場合があります。

 

戻り値:
処理結果ステータス。 必要なすべてファイルが削除された場合は true、 そうでない場合は false 。
例外:
PFComponentException - ディレクトリが設定されていない場合 ディレクトリ作成失敗の場合。

cleanAllDirectries

public boolean cleanAllDirectries()
                           throws PFComponentException
パス名が示すディレクトリ配下に存在する全ファイルを削除します。

 注意事項
 このパス名がディレクトリの配下直下のファイルが対象です。
 このオペレーションが失敗した場合でも、いくつかの	
 必要ファイルの削除は成功した場合があります	。

 

戻り値:
処理結果ステータス。 必要なすべてファイルが削除された場合は true、 そうでない場合は false 。
例外:
PFComponentException - ディレクトリが設定されていない場合

cleanAllDirectoriesOnExit

public boolean cleanAllDirectoriesOnExit()
                                  throws PFComponentException,
                                         java.lang.Exception
VM終了時にパス名が示すディレクトリ配下に存在する全ファイルを削除します。

 注意事項
 このパス名がディレクトリの配下直下のファイルが対象です。
 このオペレーションが失敗した場合でも、いくつかの	
 必要ファイルの削除は成功した場合があります	。

 

戻り値:
処理結果ステータス。 必要なすべてファイルが削除された場合は true、 そうでない場合は false 。
例外:
PFComponentException - ディレクトリが設定されていない場合
java.lang.Exception

forceDeleteDirectories

public boolean forceDeleteDirectories()
                               throws PFComponentException,
                                      java.lang.Exception
パス名が示すディレクトリ配下のファイル・ディレクトリを全て削除します。

 注意事項
 このオペレーションが失敗した場合でも、いくつかの	
 ディレクトリ・ファイルが削除されている場合があります	。

 

戻り値:
処理結果ステータス。 必要なすべてファイルが削除された場合は true、 そうでない場合は false 。
例外:
PFComponentException - ディレクトリが設定されていない場合
java.lang.Exception

forceDeleteDirectoriesOnExit

public boolean forceDeleteDirectoriesOnExit()
                                     throws PFComponentException
VM終了時にパス名が示すディレクトリ配下のファイル・ディレクトリを全て削除します。

 注意事項
 このオペレーションが失敗した場合でも、いくつかの	
 ディレクトリ・ファイルが削除されている場合があります	。

 

戻り値:
処理結果ステータス。 必要なすべてファイルが削除された場合は true、 そうでない場合は false 。
例外:
PFComponentException - ディレクトリが設定されていない場合

copyFileReserve

public boolean copyFileReserve(java.lang.String dest)
                        throws PFComponentException
パス名が示すファイルを指定パスへコピーします。 ファイル名まで指定します。

 注意事項
 ファイル名まで指定します。

 

パラメータ:
dest - - コピー先パス。
戻り値:
処理結果ステータス。 オペレーションが成功した場合は true、そうでない場合は false
例外:
PFComponentException - ディレクトリが設定されていない場合

copyFile

public boolean copyFile(java.lang.String dest)
                 throws PFComponentException
パス名が示すファイルを指定ディレクトリへコピーします。

 注意事項
 ファイル名は同名でコピーするため、ディレクトリまで指定します。

 

パラメータ:
dest - - コピー先パス。
戻り値:
処理結果ステータス。 オペレーションが成功した場合は true、そうでない場合は false
例外:
PFComponentException - ディレクトリが設定されていない場合

copyDir

public boolean copyDir(java.lang.String dest)
                throws PFComponentException
パス名が示すディレクトリを指定ディレクトリへコピーします。

 注意事項
 ディレクトリ名は同名でコピーするため、ディレクトリまで指定します。
 このオペレーションが失敗した場合でも、いくつかの	
 ディレクトリ・ファイルがコピーされている場合があります。

 

パラメータ:
dest - - コピー先パス。
戻り値:
処理結果ステータス。 必要なすべてファイルがコピーされた場合は true、 そうでない場合は false 。
例外:
PFComponentException - ディレクトリが設定されていない場合

moveFileReserve

public boolean moveFileReserve(java.lang.String dest)
                        throws PFComponentException
パス名が示すファイルを指定ディレクトリへ移動します。

 注意事項
 ファイル名まで指定します。

 

パラメータ:
dest - - 移動先パス。
戻り値:
処理結果ステータス。 オペレーションが成功した場合は true、そうでない場合は false
例外:
PFComponentException - ディレクトリが設定されていない場合

moveFile

public boolean moveFile(java.lang.String dest)
                 throws PFComponentException
パス名が示すファイルを指定ディレクトリへ移動します。

 注意事項
 ファイル名は同名でコピーするため、ディレクトリまで指定します。

 

パラメータ:
dest - - 移動先パス。
戻り値:
処理結果ステータス。 オペレーションが成功した場合は true、そうでない場合は false
例外:
PFComponentException - ディレクトリが設定されていない場合

moveDir

public boolean moveDir(java.lang.String dest)
                throws PFComponentException
パス名が示すディレクトリを指定ディレクトリへ移動します。

 注意事項
 ディレクトリ名は同名で移動するため、ディレクトリまで指定します。
 このオペレーションが失敗した場合でも、いくつかの	
 ディレクトリ・ファイルが移動されている場合があります	。

 

パラメータ:
dest - - 移動先パス。
戻り値:
処理結果ステータス。 必要なすべてファイルが移動された場合は true、 そうでない場合は false 。
例外:
PFComponentException - ディレクトリが設定されていない場合

getDirectoryLength

public long getDirectoryLength()
                        throws PFComponentException
パスの示すディレクトリのサイズを返します。

 注意事項
 配下に含まれるファイルサイズの合計です。

 

戻り値:
ディレクトリのサイズ(バイト)
例外:
PFComponentException - ディレクトリが設定されていない場合

contentEquals

public boolean contentEquals(java.lang.String dest)
                      throws PFComponentException
パスの示すファイルと、指定のファイルの中身を比較します。

 注意事項

 

戻り値:
処理結果ステータス。
例外:
PFComponentException - ファイルが設定されていない場合

setRootNodeName

public void setRootNodeName(java.lang.String nodeName)
ツリーを作成するさいのルートノードの名称。

 注意事項
 ディレクトリ構成上、異なるディレクトリ配下に存在するファイルを
 1つのツリー上で表現したい場合に使用。

 

パラメータ:
nodeName - - ルートノードの名称。

getPathSeparator

public java.lang.String getPathSeparator()
推奨されていません。  

パス名で使用する区切り文字を取得。

 注意事項

 


setPathSeparator

public void setPathSeparator(java.lang.String delim)
推奨されていません。  

パス名で使用する区切り文字を設定。

 注意事項
 システムのパスの区切り文字を使用せずに、独自で区切り文字を指定する場合に
 使用。

 

パラメータ:
delim - - 区切り文字。

getSeparator

public java.lang.String getSeparator()
パス名で使用する区切り文字を取得。

 注意事項

 


setSeparator

public void setSeparator(java.lang.String delim)
パス名で使用する区切り文字を設定。

 注意事項
 システムのパスの区切り文字を使用せずに、独自で区切り文字を指定する場合に
 使用。

 

パラメータ:
delim - - 区切り文字。

readXML

public void readXML(PFXMLLoader in)
コンポーネントのXML入力.

定義:
インタフェース PFXMLSerializable 内の readXML
パラメータ:
in - XML入力ユーティリティ

writeXML

public void writeXML(PFXMLGenerator out)
              throws java.io.IOException
コンポーネントのXML出力.

定義:
インタフェース PFXMLSerializable 内の writeXML
パラメータ:
out - XML出力ユーティリティ
例外:
java.io.IOException

getAllContentsTree

public PFObjectTree getAllContentsTree()
                                throws PFComponentException
パス名が示すディレクトリの下位に存在する全コンテンツのツリーを取得します。

 注意事項
 ディレクトリ配下が対象です。直下ではありません。
 パス名がディレクトリを示さない場合、nullを返します。

 

戻り値:
パス名が示すディレクトリ配下に存在する全コンテンツを示すツリーオブジェクト
例外:
PFComponentException - ディレクトリが設定されていない場合

getAllDirectoriesTree

public PFObjectTree getAllDirectoriesTree()
                                   throws PFComponentException
パス名が示すディレクトリの下位に存在する全ディレクトリツリーを取得します。

 注意事項
 ディレクトリ配下が対象です。直下ではありません。
 返却値にファイルは含みません。
 パス名がディレクトリを示さない場合、nullを返します。
 配下にディレクトリが存在しない場合は、空の配列を返します。

 

戻り値:
パス名が示すディレクトリ配下に存在するディレクトリを示すツリーオブジェクト
例外:
PFComponentException - ディレクトリが設定されていない場合

getAllDirectoriesTreeMulti

public PFObjectTree getAllDirectoriesTreeMulti()
                                        throws PFComponentException
パス名が示すディレクトリの下位に存在する全ディレクトリツリーを取得します。

 注意事項
 ルートノードは自動で設定します。
 ディレクトリ構成上、異なるディレクトリ配下に存在するファイルを
 1つのツリー上で表現したい場合に使用します。
 ディレクトリ配下が対象です。直下ではありません。
 返却値にファイルは含みません。
 パス名がディレクトリを示さない場合、nullを返します。
 配下にディレクトリが存在しない場合は、空の配列を返します。

 

戻り値:
パス名が示すディレクトリ配下に存在するディレクトリを示すツリーオブジェクト
例外:
PFComponentException - ディレクトリが設定されていない場合

getAllDirectoriesTreeMultiNames

public PFObjectTree getAllDirectoriesTreeMultiNames(PFObjectList names)
                                             throws PFComponentException
ファイルパス名を取得して、その数分のツリーを作成します。

 注意事項
 ルートノードは自動で設定します。
 指定したファイルパスを2階層目のノードとして作成します。
 ディレクトリ構成上、異なるディレクトリ配下に存在するファイルを
 1つのツリー上で表現したい場合に使用します。
 ディレクトリ配下が対象です。直下ではありません。
 返却値にファイルは含みません。
 パス名がディレクトリを示さない場合、nullを返します。
 配下にディレクトリが存在しない場合は、空の配列を返します。

 

戻り値:
パス名が示すディレクトリ配下に存在するディレクトリを示すツリーオブジェクト
例外:
PFComponentException - ディレクトリが設定されていない場合

getAllDirectoriesTreeMulti

public PFObjectTree getAllDirectoriesTreeMulti(PFObjectList files)
                                        throws PFComponentException
ファイルを取得して、その数分のツリーを作成します。

 注意事項
 ルートノードは自動で設定します。
 指定したファイルパスを2階層目のノードとして作成します。
 ディレクトリ構成上、異なるディレクトリ配下に存在するファイルを
 1つのツリー上で表現したい場合に使用します。
 ディレクトリ配下が対象です。直下ではありません。
 返却値にファイルは含みません。
 パス名がディレクトリを示さない場合、nullを返します。
 配下にディレクトリが存在しない場合は、空の配列を返します。

 

戻り値:
パス名が示すディレクトリ配下に存在するディレクトリを示すツリーオブジェクト
例外:
PFComponentException - ディレクトリが設定されていない場合

refreshDirectoriesTree

public PFObjectTree refreshDirectoriesTree(PFObjectTree target)
                                    throws PFComponentException
ツリーを取得して、ルートノード配下を全てリフレッシュします。

 注意事項
 ルートノードは自動で設定します。
 指定したファイルパスを2階層目のノードが対象です。
 ディレクトリ構成上、異なるディレクトリ配下に存在するファイルを
 1つのツリー上で表現したい場合に使用します。
 ディレクトリ配下が対象です。直下ではありません。
 返却値にファイルは含みません。
 パス名がディレクトリを示さない場合、nullを返します。
 配下にディレクトリが存在しない場合は、空の配列を返します。

 

戻り値:
パス名が示すディレクトリ配下に存在するディレクトリを示すツリーオブジェクト
例外:
PFComponentException - ディレクトリが設定されていない場合

refreshSubDirectoriesTree

public PFObjectTree refreshSubDirectoriesTree(PFObjectTree target,
                                              int depth)
                                       throws PFComponentException
ツリーを取得して、指定の階層配下を全てリフレッシュします。

 注意事項
 ルートノードは自動で設定します。
 指定したファイルパスを2階層目のノードが対象です。
 ディレクトリ構成上、異なるディレクトリ配下に存在するファイルを
 1つのツリー上で表現したい場合に使用します。
 ディレクトリ配下が対象です。直下ではありません。
 返却値にファイルは含みません。
 パス名がディレクトリを示さない場合、nullを返します。
 配下にディレクトリが存在しない場合は、空の配列を返します。

 

パラメータ:
target - - ツリー
depth - - 階層
戻り値:
リフレッシュ結果のツリーオブジェクト
例外:
PFComponentException - ディレクトリが設定されていない場合

addAllDirectoriesTree

public PFObjectTree addAllDirectoriesTree(PFObjectTree target)
                                   throws PFComponentException
ツリーを取得して、指定パス配下のツリーをルートノードの配下に作成します。

 注意事項

 

パラメータ:
target - - 更新対象のツリー
戻り値:
更新結果のツリーオブジェクト
例外:
PFComponentException - ディレクトリが設定されていない場合

getSubContentsTree

public PFObjectTree getSubContentsTree()
                                throws PFComponentException
パス名が示すディレクトリの直下に存在する全コンテンツのツリーを取得します。

 注意事項
 

戻り値:
パス名が示すディレクトリ直下に存在する全コンテンツを示すツリーオブジェクト
例外:
PFComponentException - ディレクトリが設定されていない場合 ディレクトリ作成失敗の場合。

getSubDirectoriesNode

public PFObjectTreeNode getSubDirectoriesNode(java.lang.String temp)
                                       throws PFComponentException
指定のディレクトリ・ファイルノードを取得します。 各ノードの直下に指定した名称でノードを作成します。

 注意事項
 なし。

 

パラメータ:
temp - 対象ディレクトリ
例外:
PFComponentException - 処理中にエラーが発生した場合。

addSubDirectoriesTree

public void addSubDirectoriesTree(PFObjectTreeNode parent,
                                  java.lang.String temp)
                           throws PFComponentException
引数のノード直下の、指定のディレクトリ・ファイルノードを設定します。 各ノードの直下に指定した名称でノードを作成します。
 なし。

 注意事項

 

パラメータ:
parent - 親ノード
temp - 対象ディレクトリ
例外:
PFComponentException - 処理中にエラーが発生した場合。

getSubDirectoriesNodeList

public PFObjectList getSubDirectoriesNodeList()
                                       throws PFComponentException
パス名が示すディレクトリの直下に存在する全ディレクトリのノードをリストで取得します。

 注意事項
 なし

 

戻り値:
ノードのリスト
例外:
PFComponentException

getSubDirectoriesNodeList

public PFObjectList getSubDirectoriesNodeList(java.lang.String temp)
                                       throws PFComponentException
パス名が示すディレクトリの直下に存在する全ディレクトリのノードをリストで取得します。 各ノードの直下に指定した名称でノードを作成します。

 注意事項
 なし

 

パラメータ:
temp - 各ノードの直下につけるノード名称
戻り値:
ノードのリスト
例外:
PFComponentException