コンストラクタの概要

SessionScopeStorage (SessionScopeStorage storage)
コンストラクタ。storage と同一のパスを指す SessionScopeStorage を作成します。
SessionScopeStorage (SessionScopeStorage parent, String child)
コンストラクタ。parent/child を指す Storage を作成します。
SessionScopeStorage (String path)
コンストラクタ。path を指す SessionScopeStorage を作成します。
SessionScopeStorage (String parent, String child)
コンストラクタ。parent/child を指す Storage を作成します。

メソッドの概要

返却値の型 メソッド名
ByteWriter appendAsBinary (Function [callback])
追記用としてコンストラクタの引数に指定した path を開きます。
TextWriter appendAsText (Function [callback], String [charsetName])
追記用としてコンストラクタの引数に指定した path を開きます。
Boolean append (String src, String [charsetName])
文字列を指定されたキャラセット名で変換しこのストレージに追記します。
Boolean copy (SessionScopeStorage to, Boolean [overwrite])
このファイル、またはディレクトリを引数で指定された対象にコピーします。
ByteWriter createAsBinary (Function [callback])
書き込み用としてコンストラクタの引数に指定した path を開きます。
TextWriter createAsText (Function [callback], String [charsetName])
書き込み用としてコンストラクタの引数に指定した path を開きます。
SessionScopeStorage[] directoriesStorages (Boolean [recursive])
このストレージが示すディレクトリ内のディレクトリを示すストレージのコレクションを返します。
String[] directories (Boolean [recursive])
このストレージが示すディレクトリの配下にあるディレクトリのパスのコレクションを返します。
Boolean exists ()
このストレージが示すファイルまたはディレクトリが存在するかどうかを判定します。
SessionScopeStorage[] filesStorages (Boolean recursive)
このストレージが示すディレクトリ内のファイルを示すストレージのコレクションを返します。
String[] files (Boolean [recursive])
このストレージが示すディレクトリの配下にあるファイルのパスのコレクションを返します。
String getCanonicalPath ()
正規化したパスを返します。
String getName ()
このストレージが示すファイルまたはディレクトリの名前を返します。
SessionScopeStorage getParentStorage ()
親ストレージを返します。
String getParent ()
親パスを返します。
String getPath ()
パス名文字列を返します。
String getRelativePath (SessionScopeStorage target)
このストレージとの相対パスを返します。
SessionScopeStorage getRootStorage ()
ルートストレージを返します。
Boolean isDirectory ()
このストレージが示すファイルがディレクトリであるかどうかを判定します。
Boolean isFile ()
このストレージが示すファイルが普通のファイルかどうかを判定します。ファイルは、それがディレクトリではなく、システムに依存するほかの基準を満たす場合に「普通」のファイルと見なされます。
Number lastModified ()
このストレージが示すファイルが最後に変更された時刻を返します。
Number length ()
このストレージが指定されているファイルの長さを返します。パス名にディレクトリが指定されている場合、戻り値は指定されません。
SessionScopeStorage[] listStorages (Object [filterOrRecursive])
このストレージが示すディレクトリ内のファイルおよびディレクトリを示すストレージのコレクションを返します。
String[] list (Object [filterOrRecursive])
このストレージが示すディレクトリの配下にあるファイル、および、ディレクトリのパスのコレクションを返します。
String load () 非推奨
このストレージの内容を取得します。
旧 API からの置き換えを容易にするために用意してはいますが、新規の開発において、転送するファイルのサイズが大きくならない余程の確信が無い限りは、これらの API を使用しないで下さい。代わりに openAsBinary, createAsBinary, appendAsBinary, openAsText, createAsText, appendAsText を使用してください
Boolean makeDirectories ()
このストレージが示すディレクトリを生成します。
Boolean move (String newPath)
このストレージが示すファイルを移動します。
ByteReader openAsBinary (Function [callback])
読み込み用としてコンストラクタの引数に指定した path を開きます。
TextReader openAsText (Function [callback], String [charsetName])
読み込み用としてコンストラクタの引数に指定した path を開きます。
String read (String [charsetName]) 非推奨
このストレージの内容を指定されたキャラセット名で変換し文字列で取得します。
旧 API からの置き換えを容易にするために用意してはいますが、新規の開発において、転送するファイルのサイズが大きくならない余程の確信が無い限りは、これらの API を使用しないで下さい。代わりに openAsBinary, createAsBinary, appendAsBinary, openAsText, createAsText, appendAsText を使用してください
Boolean remove (Boolean [recursive])
このストレージが示すファイルまたはディレクトリを削除します。
SessionScopeStorage resolve (String other)
このストレージから相対ストレージを返します。
Boolean save (String byteStream)
ファイルの中身をこのストレージに書き込みます。
Boolean write (String src, String [charsetName])
文字列を指定されたキャラセット名でこのストレージに書き込みます。

コンストラクタの詳細

SessionScopeStorage (SessionScopeStorage storage)
コンストラクタ。storage と同一のパスを指す SessionScopeStorage を作成します。
パラメータ
storage : SessionScopeStorage
セッションスコープストレージ
SessionScopeStorage (SessionScopeStorage parent, String child)
コンストラクタ。parent/child を指す Storage を作成します。
パラメータ
parent : SessionScopeStorage
親のセッションスコープストレージ
child : String
子フォルダのパス
SessionScopeStorage (String path)
コンストラクタ。path を指す SessionScopeStorage を作成します。
パラメータ
path : String
セッションスコープストレージのパス
SessionScopeStorage (String parent, String child)
コンストラクタ。parent/child を指す Storage を作成します。
パラメータ
parent : String
親フォルダのパス
child : String
子フォルダのパス

メソッドの詳細

ByteWriter appendAsBinary (Function [callback])
追記用としてコンストラクタの引数に指定した path を開きます。
callback が渡された場合、callback の第 1 引数に ByteWriter, 第 2 引数に Error を渡し、ファイルの close は API が自動で行います(エラーがなかった場合、第 2 引数は null が渡されます)。
パラメータ
[callback] : Function
エラー発生時には、第 1 引数は null, 第 2 引数は Error = new Error(...) が渡されます。
返却値
ByteWriter
ByteWriter 生成した ByteWriter。開けなかった場合は null。
TextWriter appendAsText (Function [callback], String [charsetName])
追記用としてコンストラクタの引数に指定した path を開きます。
callback が渡された場合、callback の第 1 引数に TextWriter, 第 2 引数に Error を渡し、ファイルの close は API が自動で行います(エラーがなかった場合、第 2 引数は null が渡されます)。
パラメータ
[callback] : Function
エラー発生時には、第 1 引数は null, 第 2 引数は Error = new Error(...) が渡されます。
[charsetName] : String
キャラセット名
指定可能なキャラセット名は java.nio.charset.Charset がサポートしているものとなります。
返却値
TextWriter
TextWriter 生成した TextWriter。開けなかった場合は null。
Boolean append (String src, String [charsetName])
文字列を指定されたキャラセット名で変換しこのストレージに追記します。
パラメータ
src : String
文字列
[charsetName] : String
キャラセット名(省略時はUTF-8を利用します。)
指定可能なキャラセット名は java.nio.charset.Charset がサポートしているものとなります。
返却値
Boolean
Boolean 失敗した場合は false(null ではなくて false です)。
Boolean copy (SessionScopeStorage to, Boolean [overwrite])
このファイル、またはディレクトリを引数で指定された対象にコピーします。
このインスタンスが存在しない場合:
  • IOException(FileNotFoundException)がスローされます。
このインスタンスがファイルの場合:
  • toが存在しない場合はtoに対してコピーを行います。
  • toがファイルの場合は、引数overwriteに従います。
  • toがディレクトリの場合はIOExceptionがスローされます。
このインスタンスがディレクトリの場合:
  • toが存在しない場合はtoディレクトリを作成し、コピーを行います。
  • toがファイルの場合はIOExceptionがスローされます。
  • toがディレクトリの場合、かつtoディレクトリ配下にファイルまたはフォルダが存在した場合は引数overwiteに従います。
    このインスタンス配下のファイルと同名の階層のフォルダがコピー先に存在した場合はIOExceptionがスローされます。
  • toがディレクトリの場合、かつtoディレクトリ配下にファイルまたはフォルダが存在していない場合はこのインスタンス配下のファイルまたはディレクトリをtoディレクトリ配下にコピーします。
  • toがディレクトリの場合、かつこのインスタンス配下のファイルと一致しないファイルがtoディレクトリ配下に存在した場合は、そのファイルに対しては何も行われません。
    (mergeする動作となります、削除が必要な場合はコピー先に対して remove(boolean) を呼び出した後このメソッドを実行して下さい)
パラメータ
to : SessionScopeStorage
コピー先
[overwrite] : Boolean
trueの場合上書きします
返却値
Boolean
Boolean 失敗した場合は false。
ByteWriter createAsBinary (Function [callback])
書き込み用としてコンストラクタの引数に指定した path を開きます。
callback が渡された場合、callback の第 1 引数に ByteWriter, 第 2 引数に Error を渡し、ファイルの close は API が自動で行います(エラーがなかった場合、第 2 引数は null が渡されます)。
パラメータ
[callback] : Function
エラー発生時には、第 1 引数は null, 第 2 引数は Error = new Error(...) が渡されます。
返却値
ByteWriter
ByteWriter 生成した ByteWriter。開けなかった場合は null。
TextWriter createAsText (Function [callback], String [charsetName])
書き込み用としてコンストラクタの引数に指定した path を開きます。
callback が渡された場合、callback の第 1 引数に TextWriter, 第 2 引数に Error を渡し、ファイルの close は API が自動で行います(エラーがなかった場合、第 2 引数は null が渡されます)。
パラメータ
[callback] : Function
エラー発生時には、第 1 引数は null, 第 2 引数は Error = new Error(...) が渡されます。
[charsetName] : String
キャラセット名
指定可能なキャラセット名は java.nio.charset.Charset がサポートしているものとなります。
返却値
TextWriter
TextWriter 生成した TextWriter。開けなかった場合は null。
SessionScopeStorage[] directoriesStorages (Boolean [recursive])
このストレージが示すディレクトリ内のディレクトリを示すストレージのコレクションを返します。
パラメータ
[recursive] : Boolean
ディレクトリを再帰的に探索する場合は true、そうでない場合は false(省略時はdirectoriesStorages(false) と同値。)
返却値
SessionScopeStorage[]
SessionScopeStorage[] このストレージが示すディレクトリ内のディレクトリを示すストレージのコレクション。コレクションは、ディレクトリが空の場合は空になる。このストレージがディレクトリを示さない場合、または入出力エラーが発生した場合は null
String[] directories (Boolean [recursive])
このストレージが示すディレクトリの配下にあるディレクトリのパスのコレクションを返します。
パスは、このストレージのパスからの相対パスです。
ディレクトリが空の場合は空コレクションを返します。
このストレージがディレクトリを示さない場合は null を返します。
 ROOT
 ┗directory-1
   ┗directory-1-1
     ┣directory-1-1-1
     ┃┣directory-1-1-1-1
     ┃┗file-1-1-1-2
     ┣directory-1-1-2
     ┣file-1-1-3
     ┗file-1-1-4
 
上記のようなファイル構成である場合、
directory-1-1に対してdirectories(false)を実行した場合の戻り値は以下の通りです。
  • directory-1-1-1
  • directory-1-1-2
directory-1-1に対してdirectories(true)を実行した場合の戻り値は以下の通りです。
  • directory-1-1-1
  • directory-1-1-1/directory-1-1-1-1
  • directory-1-1-2
パラメータ
[recursive] : Boolean
ディレクトリを再帰的に探索する場合は true、そうでない場合は false(省略時はdirectories(false) と同値。)
返却値
String[]
String[] このストレージが示すディレクトリの配下にあるディレクトリのパスのコレクション
Boolean exists ()
このストレージが示すファイルまたはディレクトリが存在するかどうかを判定します。
返却値
Boolean
Boolean ファイルまたはディレクトリが存在する場合は true、そうでない場合は false(失敗した場合は null または false。)
SessionScopeStorage[] filesStorages (Boolean recursive)
このストレージが示すディレクトリ内のファイルを示すストレージのコレクションを返します。
パラメータ
recursive : Boolean
ディレクトリを再帰的に探索する場合は true、そうでない場合は false(filesStorages(false) と同値。)
返却値
SessionScopeStorage[]
SessionScopeStorage[] このストレージが示すディレクトリ内のファイルを示すストレージのコレクション。コレクションは、ディレクトリが空の場合は空になる。このストレージがディレクトリを示さない場合、または入出力エラーが発生した場合は null
String[] files (Boolean [recursive])
このストレージが示すディレクトリの配下にあるファイルのパスのコレクションを返します。
パスは、このストレージのパスからの相対パスです。
ディレクトリが空の場合は空コレクションを返します。
このストレージがディレクトリを示さない場合は null を返します。
 ROOT
 ┗directory-1
   ┗directory-1-1
     ┣directory-1-1-1
     ┃┣directory-1-1-1-1
     ┃┗file-1-1-1-2
     ┣directory-1-1-2
     ┣file-1-1-3
     ┗file-1-1-4
 
上記のようなファイル構成である場合、
directory-1-1に対してfiles(false)を実行した場合の戻り値は以下の通りです。
  • file-1-1-3
  • file-1-1-4
directory-1-1に対してfiles(true)を実行した場合の戻り値は以下の通りです。
  • directory-1-1-1/file-1-1-1-2
  • file-1-1-3
  • file-1-1-4
パラメータ
[recursive] : Boolean
ディレクトリを再帰的に探索する場合は true、そうでない場合は false(省略時はfiles(false) と同値。)
返却値
String[]
String[] このストレージが示すディレクトリの配下にあるファイルのパスのコレクション
String getCanonicalPath ()
正規化したパスを返します。
返却値
String
String 正規化したパス(失敗した場合は null。)
String getName ()
このストレージが示すファイルまたはディレクトリの名前を返します。
返却値
String
String ファイルまたはディレクトリの名前(失敗した場合は null。)
SessionScopeStorage getParentStorage ()
親ストレージを返します。
返却値
SessionScopeStorage
SessionScopeStorage 親ストレージ。このストレージがルートストレージだった場合は、null(失敗した場合は null。)
String getParent ()
親パスを返します。
返却値
String
String 親パス(失敗した場合は null。)
String getPath ()
パス名文字列を返します。
返却値
String
String パス名文字列(失敗した場合は null。)
String getRelativePath (SessionScopeStorage target)
このストレージとの相対パスを返します。
パラメータ
target : SessionScopeStorage
比較対象ストレージ
返却値
String
String このストレージとの相対パスを返します。(失敗した場合は null。)
SessionScopeStorage getRootStorage ()
ルートストレージを返します。
返却値
SessionScopeStorage
SessionScopeStorage ルートストレージ(失敗した場合は null。)
Boolean isDirectory ()
このストレージが示すファイルがディレクトリであるかどうかを判定します。
返却値
Boolean
Boolean このストレージが示すファイルが存在し、さらにそれがディレクトリである場合は true、そうでない場合は false(失敗した場合は null または false。)
Boolean isFile ()
このストレージが示すファイルが普通のファイルかどうかを判定します。ファイルは、それがディレクトリではなく、システムに依存するほかの基準を満たす場合に「普通」のファイルと見なされます。 アプリケーションが生成したディレクトリ以外のファイルは、必ず普通のファイルです。
返却値
Boolean
Boolean このストレージが示すファイルが存在し、さらにそれが普通のファイルである場合は true、そうでない場合は false(失敗した場合は null または false。)
Number lastModified ()
このストレージが示すファイルが最後に変更された時刻を返します。
返却値
Number
Number ファイルが最後に変更された時刻を表す long 値。エポック (1970 年 1 月 1 日 0 時 0 分 0 秒、グリニッジ標準時) からミリ秒単位で測定。ファイルが存在しないか、入出力エラーが発生した場合は null
Number length ()
このストレージが指定されているファイルの長さを返します。パス名にディレクトリが指定されている場合、戻り値は指定されません。
返却値
Number
Number このストレージが示すファイルの長さ (バイト単位)。ファイルが存在しない場合は null。一部のオペレーティングシステムでは、デバイスやパイプなどのシステム依存エンティティーを示すパス名について null を返すことがあります。
SessionScopeStorage[] listStorages (Object [filterOrRecursive])
このストレージが示すディレクトリ内のファイルおよびディレクトリを示すストレージのコレクションを返します。
パラメータ
[filterOrRecursive] : Object
どちらかを指定できます。(省略時はlistStorages(false) と同値。)
  • recursiveを指定する場合:Boolean ディレクトリを再帰的に探索する場合は true、そうでない場合は false
  • filterを指定する場合:Function ファイル名フィルタ
返却値
SessionScopeStorage[]
SessionScopeStorage[] このストレージが示すディレクトリ内のファイルおよびディレクトリを示すストレージのコレクション。コレクションは、ディレクトリが空の場合は空になる。このストレージがディレクトリを示さない場合、または入出力エラーが発生した場合は null
String[] list (Object [filterOrRecursive])
このストレージが示すディレクトリの配下にあるファイル、および、ディレクトリのパスのコレクションを返します。
パスは、このストレージのパスからの相対パスです。
引数にファイル名フィルタが渡された場合、関数 の第 1 引数に listを実行した SharePointStorage が、第 2 引数に 対象のファイル名 を渡します。
関数の戻り値がtrueである場合、対象が取得対象となります。
ディレクトリが空の場合は空コレクションを返します。
このストレージがディレクトリを示さない場合は null を返します。
 ROOT
 ┗directory-1
   ┗directory-1-1
     ┣directory-1-1-1
     ┃┣directory-1-1-1-1
     ┃┗file-1-1-1-2
     ┣directory-1-1-2
     ┣file-1-1-3
     ┗file-1-1-4
 
上記のようなファイル構成である場合、
directory-1-1に対してlist(false)を実行した場合の戻り値は以下の通りです。
  • directory-1-1-1
  • directory-1-1-2
  • file-1-1-3
  • file-1-1-4
directory-1-1に対してlist(true)を実行した場合の戻り値は以下の通りです。
  • directory-1-1-1
  • directory-1-1-1/directory-1-1-1-1
  • directory-1-1-1/file-1-1-1-2
  • directory-1-1-2
  • file-1-1-3
  • file-1-1-4
パラメータ
[filterOrRecursive] : Object
どちらかを指定できます。(省略時はlist(false) と同値。)
  • recursiveを指定する場合:Boolean ディレクトリを再帰的に探索する場合は true、そうでない場合は false
  • filterを指定する場合:Function ファイル名フィルタ
返却値
String[]
String[] このストレージが示すディレクトリにあるファイルおよびディレクトリ名のコレクション、または、ファイルおよびディレクトリパスのコレクション。
String load () 非推奨
旧 API からの置き換えを容易にするために用意してはいますが、新規の開発において、転送するファイルのサイズが大きくならない余程の確信が無い限りは、これらの API を使用しないで下さい。代わりに openAsBinary, createAsBinary, appendAsBinary, openAsText, createAsText, appendAsText を使用してください
このストレージの内容を取得します。
返却値
String
String ストレージの内容(失敗した場合は null。)
Boolean makeDirectories ()
このストレージが示すディレクトリを生成します。
返却値
Boolean
Boolean 必要なすべての親ディレクトリを含めてディレクトリが生成された場合は true、そうでない場合は false(失敗した場合は null または false。)
Boolean move (String newPath)
このストレージが示すファイルを移動します。
パラメータ
newPath : String
このストレージの新しいパス
返却値
Boolean
Boolean 移動が成功した場合は true、そうでない場合は false(失敗した場合は null または false。)
ByteReader openAsBinary (Function [callback])
読み込み用としてコンストラクタの引数に指定した path を開きます。
callbackが渡された場合、callback の第 1 引数に ByteReader, 第 2 引数に Error を渡し、ファイルの close は API が自動で行います(エラーがなかった場合、第 2 引数は null が渡されます)。
パラメータ
[callback] : Function
エラー発生時には、第 1 引数は null, 第 2 引数は Error = new Error(...) が渡されます。
返却値
ByteReader
ByteReader 生成した ByteReader。開けなかった場合は null。
TextReader openAsText (Function [callback], String [charsetName])
読み込み用としてコンストラクタの引数に指定した path を開きます。
callback が渡された場合、callback の第 1 引数に TextReader, 第 2 引数に Error を渡し、ファイルの close は API が自動で行います(エラーがなかった場合、第 2 引数は null が渡されます)。
パラメータ
[callback] : Function
エラー発生時には、第 1 引数は null, 第 2 引数は Error = new Error(...) が渡されます。
[charsetName] : String
キャラセット名
指定可能なキャラセット名は java.nio.charset.Charset がサポートしているものとなります。
返却値
TextReader
TextReader 生成した TextReader。開けなかった場合は null。
String read (String [charsetName]) 非推奨
旧 API からの置き換えを容易にするために用意してはいますが、新規の開発において、転送するファイルのサイズが大きくならない余程の確信が無い限りは、これらの API を使用しないで下さい。代わりに openAsBinary, createAsBinary, appendAsBinary, openAsText, createAsText, appendAsText を使用してください
このストレージの内容を指定されたキャラセット名で変換し文字列で取得します。
パラメータ
[charsetName] : String
キャラセット名(省略時はUTF-8を利用します。)
指定可能なキャラセット名は java.nio.charset.Charset がサポートしているものとなります。
返却値
String
String ストレージの内容の文字列(失敗した場合は null。)
Boolean remove (Boolean [recursive])
このストレージが示すファイルまたはディレクトリを削除します。
recursive に明示的に true が渡されたときのみ、再帰的に削除します。
パラメータ
[recursive] : Boolean
ディレクトリを再帰的に探索する場合は true、そうでない場合は false(省略時はremove(false)と同値。)
返却値
Boolean
Boolean ファイルまたはディレクトリが正常に削除された場合は true、そうでない場合は false(失敗した場合は null または false。)
SessionScopeStorage resolve (String other)
このストレージから相対ストレージを返します。
現在のパスから other だけ移動した新しい SessionScopeStorage を返す。
例:
 new SessionScopeStorage('a/b/c').resolve('..') -> 'a/b' を指す SessionScopeStorage
 
パラメータ
other : String
このストレージからの相対パス
返却値
SessionScopeStorage
SessionScopeStorage このストレージからの相対ストレージ(失敗した場合は null。)
Boolean save (String byteStream)
ファイルの中身をこのストレージに書き込みます。
パラメータ
byteStream : String
ファイルの中身
返却値
Boolean
Boolean 失敗した場合は null または false。
Boolean write (String src, String [charsetName])
文字列を指定されたキャラセット名でこのストレージに書き込みます。
パラメータ
src : String
文字列
[charsetName] : String
キャラセット名(省略時はUTF-8を利用します。)
指定可能なキャラセット名は java.nio.charset.Charset がサポートしているものとなります。
返却値
Boolean
Boolean 失敗した場合は false(null ではなくて false です)。