intra-mart 6.1.14

jp.co.intra_mart.foundation.service.client.file
クラス NetworkFile

java.lang.Object
  拡張jp.co.intra_mart.foundation.service.client.NetworkConnector
      拡張jp.co.intra_mart.foundation.service.client.NetworkAgent
          拡張jp.co.intra_mart.foundation.service.client.file.AbstractComponent
              拡張jp.co.intra_mart.foundation.service.client.file.NetworkFile
すべての実装インタフェース:
ActionListener, Serializable

public class NetworkFile
extends AbstractComponent
implements Serializable

Storage Service のファイルを扱う事の出来るオブジェクトです。

このオブジェクトのすべてのメソッドは、Storage Service に対する オペレーションになります。
分散サーバ形態で運用している場合、他のコンピュータに 保管されているファイルを扱う事が出来ます。 このオブジェクトの各メソッド実行時は、Storage Service と通信を行います。

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

フィールドの概要
 
クラス jp.co.intra_mart.foundation.service.client.NetworkAgent から継承したフィールド
NULL_DATA
 
クラス jp.co.intra_mart.foundation.service.client.NetworkConnector から継承したフィールド
GET, GET_ENTIRETY, GET_ENTIRETY_KEY, GET_ITEM, GET_ITEM_KEY, GET_SUBSET, MOVE, MOVE_ENTIRETY, MOVE_ITEM, REMOVE, REMOVE_ENTIRETY, REMOVE_ITEM, SET, SET_ENTIRETY, SET_ITEM
 
コンストラクタの概要
NetworkFile(String path)
          新しいオブジェクトを構築します。
 
メソッドの概要
 Object action(Object args)
          推奨されていません。  
 boolean append(String src)
          ファイルにテキストを追記します。
 Collection directories()
          ディレクトリ中のサブディレクトリの一覧を取得します。
 boolean exists()
          このパス名が示すファイルが存在するかどうかを判定します。
 Collection files()
          ディレクトリ中のファイルの一覧を取得します。
 String getPath()
          このオブジェクトが表すパスを返します。
 boolean isDirectory()
          このパス名が示すファイルがディレクトリであるかどうかを判定します。
 boolean isFile()
          このパス名が示すファイルが普通のファイルかどうかを判定します。
 long lastModified()
          このパス名が示すファイルが最後に変更された時刻を返します。
 long length()
          このパス名が示すファイルの長さを返します。
 Collection lists()
          ディレクトリ中のファイルの一覧を取得します。
 byte[] load()
          ファイルの内容を取得します。
 boolean makeDirectories()
          このパス名が示すディレクトリを生成します。
 boolean move(String newPath)
          このパス名が示すファイルの名前を変更します。
 String read()
          ファイルの内容を取得します。
 boolean remove()
          このパス名が示すファイルまたはディレクトリを削除します。
 boolean save(byte[] byteStream)
          ファイルにバイトを出力します。
 boolean write(String src)
          ファイルにテキストを出力します。
 
クラス jp.co.intra_mart.foundation.service.client.file.AbstractComponent から継承したメソッド
connection, getInstance
 
クラス jp.co.intra_mart.foundation.service.client.NetworkAgent から継承したメソッド
execute
 
クラス jp.co.intra_mart.foundation.service.client.NetworkConnector から継承したメソッド
close, execute, freeMemory, isConnected, serverTime, totalMemory
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

NetworkFile

public NetworkFile(String path)
新しいオブジェクトを構築します。

このインスタンスは、Storage Service のファイル管理ディレクトリ(標準では storage/)以下の path で アクセスできるファイルまたはディレクトリを扱う事が出来ます。

パラメータ:
path - パス名
例外:
NullPointerException - 引数が null
メソッドの詳細

getPath

public String getPath()
このオブジェクトが表すパスを返します。 このメソッドは、コンストラクタで指定されたパスをそのまま返します。

戻り値:
パス

files

public Collection files()
                 throws IOException
ディレクトリ中のファイルの一覧を取得します。

コレクションの各要素は String です。

戻り値:
ファイル名一覧
例外:
IOException - 入出力エラーまたは対象パスに使用できない文字が使用されていた場合

directories

public Collection directories()
                       throws IOException
ディレクトリ中のサブディレクトリの一覧を取得します。

コレクションの各要素は String です。

戻り値:
サブディレクトリ名一覧
例外:
IOException - 入出力エラーまたは対象パスに使用できない文字が使用されていた場合

lists

public Collection lists()
                 throws IOException
ディレクトリ中のファイルの一覧を取得します。

ディレクトリに含まれるすべてのファイルを検索します。
ファイル名の取得対象は、サブディレクトリに存在するファイルも含まれます。
ディレクトリは取得対象ではありません。
コレクションの各要素は String です。

戻り値:
ファイル一覧
例外:
IOException - 入出力エラーまたは対象パスに使用できない文字が使用されていた場合

read

public String read()
            throws IOException
ファイルの内容を取得します。

ファイル内のテキストを Unicode に変換して返します。
テキストは、Storage Service の動作している Service Platform のサーバ側文字コードに設定されている文字コードで あるものとして読み込みます。

以下の場合は、空文字列が返却されます。
・対象パスのファイルが存在しない
・対象パスがディレクトリ
・対象パスのファイルの内容が空

戻り値:
ファイルの内容
例外:
IOException - 入出力エラーまたは対象パスに使用できない文字が使用されていた場合

write

public boolean write(String src)
              throws IOException
ファイルにテキストを出力します。

指定の内容のテキストファイルを作成します。 すでにファイルが存在している場合は、上書きされます。
ファイルに書き出されたテキストは、Storage Service の動作している Service Platform のサーバ側文字コードに設定されている文字コードに 変換されています。

このメソッドは、ファイルに出力する文字を文字コード変換する際に、 AdvancedOutputStreamWriter を利用しています。 これにより、Java-VM が持つ文字コード間のマッピングに起因した文字化けに 対して、いくつかの文字の文字化けを回避しています。 文字化けを回避できる文字については、 CharacterEncoder の仕様を参照してください。

パラメータ:
src - ファイルに書き出すテキスト
戻り値:
ファイルへのテキストの書き出しに成功した場合 true
例外:
IOException - 入出力エラーまたは対象パスに使用できない文字が使用されていた場合

append

public boolean append(String src)
               throws IOException
ファイルにテキストを追記します。

指定の内容をテキストファイルに追記します。 すでにファイルが存在している場合は、追記されます。 ファイルが存在していない場合、新しいファイルを作成します。
ファイルに書き出されたテキストは、Storage Service の動作している Service Platform のサーバ側文字コードに設定されている文字コードに 変換されています。

このメソッドは、ファイルに出力する文字を文字コード変換する際に、 AdvancedOutputStreamWriter を利用しています。 これにより、Java-VM が持つ文字コード間のマッピングに起因した文字化けに 対して、いくつかの文字の文字化けを回避しています。 文字化けを回避できる文字については、 CharacterEncoder の仕様を参照してください。

パラメータ:
src - ファイルに書き出すテキスト
戻り値:
ファイルへのテキストの書き出しに成功した場合 true
例外:
IOException - 入出力エラーまたは対象パスに使用できない文字が使用されていた場合

load

public byte[] load()
            throws IOException
ファイルの内容を取得します。

ファイルデータはバイナリ形式で取得されます。

以下の場合は、空の配列が返却されます。
・対象パスのファイルの内容が空

また以下の場合は、nullが返却されます。
・対象パスのファイルが存在しない
・対象パスがディレクトリ

戻り値:
バイト列
例外:
IOException - 入出力エラーまたは対象パスに使用できない文字が使用されていた場合

save

public boolean save(byte[] byteStream)
             throws IOException
ファイルにバイトを出力します。

指定の内容のファイルを作成します。 すでにファイルが存在している場合は、上書きされます。 ファイルが存在していない場合、新しいファイルを作成します。

パラメータ:
byteStream - ファイルに書き出すバイト
戻り値:
ファイルへのバイト列の書き出しに成功した場合 true
例外:
IOException - 入出力エラーまたは対象パスに使用できない文字が使用されていた場合

makeDirectories

public boolean makeDirectories()
                        throws IOException
このパス名が示すディレクトリを生成します。

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

戻り値:
必要なすべての親ディレクトリを含めてディレクトリが作成された場合 は true、そうでない場合は false
例外:
IOException - 入出力エラーまたは対象パスに使用できない文字が使用されていた場合

remove

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

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

戻り値:
ファイルまたはディレクトリが正常に削除された場合は true、そうでない場合は false
例外:
IOException - 入出力エラーまたは対象パスに使用できない文字が使用されていた場合

move

public boolean move(String newPath)
             throws IOException
このパス名が示すファイルの名前を変更します。

パラメータ:
newPath - 示されたファイルの新しいパス名
戻り値:
名前の変更が成功した場合は true、そうでない場合は false
例外:
IOException - 入出力エラーまたは対象パスに使用できない文字が使用されていた場合

exists

public boolean exists()
               throws IOException
このパス名が示すファイルが存在するかどうかを判定します。

戻り値:
このパス名が示すファイルが存在する場合は true、 そうでない場合は false
例外:
IOException - 入出力エラーまたは対象パスに使用できない文字が使用されていた場合

isFile

public boolean isFile()
               throws IOException
このパス名が示すファイルが普通のファイルかどうかを判定します。

ファイルは、それがディレクトリではなく、システムに依存するほかの 基準を満たす場合に「普通」のファイルと見なされます。 このオブジェクトにより生成されたディレクトリ以外のファイルは、 必ず普通のファイルです。

戻り値:
このパス名が示すファイルが存在し、 それが普通のファイルである場合は true、 そうでない場合は false
例外:
IOException - 入出力エラーまたは対象パスに使用できない文字が使用されていた場合

isDirectory

public boolean isDirectory()
                    throws IOException
このパス名が示すファイルがディレクトリであるかどうかを判定します。

戻り値:
このパス名が示すファイルが存在し、 それがディレクトリである場合は true、 そうでない場合は false
例外:
IOException - 入出力エラーまたは対象パスに使用できない文字が使用されていた場合

lastModified

public long lastModified()
                  throws IOException
このパス名が示すファイルが最後に変更された時刻を返します。

戻り値:
ファイルが最後に変更された時刻を表す long 値。 エポック (00:00:00 GMT, January 1, 1970) からミリ秒単位で測定。 ファイルが存在しないか、入出力エラーが発生した場合は 0L
例外:
IOException - 入出力エラーまたは対象パスに使用できない文字が使用されていた場合

length

public long length()
            throws IOException
このパス名が示すファイルの長さを返します。

戻り値:
このパス名が示すファイルの長さ (バイト単位)、 ファイルが存在しない場合は 0L
例外:
IOException - 入出力エラーまたは対象パスに使用できない文字が使用されていた場合

action

public Object action(Object args)
推奨されていません。  

処理ロジックの実行。

定義:
インタフェース ActionListener 内の action
定義:
クラス NetworkAgent 内の action
パラメータ:
args - 実行時引数
戻り値:
実行結果
関連項目:
NetworkAgent.execute(Object)

intra-mart 6.1.14

Copyright © 2000-2010 NTT DATA INTRAMART CO.,LTD.. All Rights Reserved.