com.JRcServer.commons.io.env
クラス EnvFileInputStream

java.lang.Object
  上位を拡張 java.io.InputStream
      上位を拡張 com.JRcServer.commons.io.env.EnvFileInputStream
すべての実装されたインタフェース:
java.io.Closeable

public class EnvFileInputStream
extends java.io.InputStream

環境変数対応版[java.io.FileInputStream]オブジェクト.

[java.io.FileInputStream]の読み込み対象名に環境変数が含まれている場合、 それらを解析して、読み込み対象に変換します.

導入されたバージョン:
JRcCommons 1.00
バージョン:
1.0.0 2005/05/02
作成者:
masahito suzuki

コンストラクタの概要
EnvFileInputStream(java.io.File file)
          コンストラクタ.
EnvFileInputStream(java.io.FileDescriptor fdObj)
          コンストラクタ.
EnvFileInputStream(java.lang.String name)
          コンストラクタ.
 
メソッドの概要
 int available()
          読み込みが可能なデータ長を取得.
 void close()
          情報クローズ.
 java.io.FileDescriptor getFD()
          ストリームに関連したファイル記述子を取得.
 void mark(int offset)
          マーク処理.
 boolean markSupported()
          マーク処理サポートチェック.
 int read()
          1バイトのデータを読み込みます.
 int read(byte[] binary)
          指定バイト情報を読み込み.
 int read(byte[] binary, int offset, int length)
          指定バイト情報を読み込み.
 void reset()
          マーク処理に対するリセット処理.
 long skip(long n)
          スキップ処理.
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

EnvFileInputStream

public EnvFileInputStream(java.io.File file)
                   throws java.io.IOException
コンストラクタ.

読み込みファイルをオープンします.

パラメータ:
file - 対象のファイルオブジェクトを設定します.
例外:
java.io.IOException - ファイル名が存在しない場合発生.
java.lang.SecurityException - セキュリティマネージャが存在し、 checkRead メソッドがファイルへの読み込み アクセスを拒否する場合発生.

EnvFileInputStream

public EnvFileInputStream(java.io.FileDescriptor fdObj)
コンストラクタ.

読み込みファイルをオープンします.

パラメータ:
fdObj - 対象のファイルディスクリプタを設定します.
例外:
java.lang.SecurityException - セキュリティマネージャが存在し、 checkRead メソッドがファイルへの読み込み アクセスを拒否する場合発生.

EnvFileInputStream

public EnvFileInputStream(java.lang.String name)
                   throws java.io.IOException
コンストラクタ.

読み込みファイルをオープンします.

パラメータ:
name - 対象のファイル名を設定します.
このファイル名に対して環境変数名を含めて設定する事が 可能です.
例外:
java.io.IOException - ファイル名が存在しない場合発生.
java.lang.SecurityException - セキュリティマネージャが存在し、 checkRead メソッドがファイルへの読み込み アクセスを拒否する場合発生.
メソッドの詳細

close

public final void close()
                 throws java.io.IOException
情報クローズ.

情報をクローズします.

定義:
インタフェース java.io.Closeable 内の close
オーバーライド:
クラス java.io.InputStream 内の close
例外:
java.io.IOException - 入出力エラーが発生した場合.

getFD

public final java.io.FileDescriptor getFD()
                                   throws java.io.IOException
ストリームに関連したファイル記述子を取得.

ストリームに関連したファイル記述子を取得します.

戻り値:
FileDescriptor この FileOutputStream オブジェクトによって使用されている ファイルシステムのファイルへの接続を表す FileDescriptor オブジェクト.
例外:
java.io.IOException - 入出力エラーが発生した場合.

read

public final int read()
               throws java.io.IOException
1バイトのデータを読み込みます.

1バイトのデータを読み込みます.

定義:
クラス java.io.InputStream 内の read
戻り値:
int 1バイトのデータが返されます.
例外:
java.io.IOException - IO例外.

read

public final int read(byte[] binary)
               throws java.io.IOException
指定バイト情報を読み込み.

指定バイト情報を読み込みます.

オーバーライド:
クラス java.io.InputStream 内の read
パラメータ:
binary - 読み込まれた情報が返されるバイナリを設定します.
[binary == null]の場合NullPointerExceptionが発生します.
戻り値:
int 読み込まれたバイト数が返されます.
読み込み先が存在しない場合[-1]が返されます.
例外:
java.io.IOException - IO例外.

read

public final int read(byte[] binary,
                      int offset,
                      int length)
               throws java.io.IOException
指定バイト情報を読み込み.

指定バイト情報を読み込みます.

オーバーライド:
クラス java.io.InputStream 内の read
パラメータ:
binary - 読み込まれた情報が返されるバイナリを設定します.
[binary == null]の場合NullPointerExceptionが発生します.
offset - 読み込み格納先の位置を設定します.
length - 読み込み情報長を設定します.
戻り値:
int 読み込まれたバイト数が返されます.
読み込み先が存在しない場合[-1]が返されます.
例外:
java.io.IOException - IO例外.

skip

public final long skip(long n)
                throws java.io.IOException
スキップ処理.

スキップ処理を行います.

オーバーライド:
クラス java.io.InputStream 内の skip
パラメータ:
n - スキップ長を設定します.
戻り値:
long 実際にスキップされたデータ長が返されます.
例外:
java.io.IOException

available

public final int available()
                    throws java.io.IOException
読み込みが可能なデータ長を取得.

読み込みが可能なデータ長を取得します.

オーバーライド:
クラス java.io.InputStream 内の available
戻り値:
int 読み込みが可能なデータ長が返されます.
例外:
java.io.IOException - IO例外.

mark

public final void mark(int offset)
マーク処理.

マーク処理を行います.
またマークした位置に戻す場合は [EFileInputStream.reset()]を利用します.

オーバーライド:
クラス java.io.InputStream 内の mark
パラメータ:
offset - 現在の位置からのオフセット値を設定します.

reset

public final void reset()
                 throws java.io.IOException
マーク処理に対するリセット処理.

リセット処理を行います.

オーバーライド:
クラス java.io.InputStream 内の reset
例外:
java.io.IOException - IO例外.

markSupported

public final boolean markSupported()
マーク処理サポートチェック.

マーク処理がサポートされているかチェックします.

オーバーライド:
クラス java.io.InputStream 内の markSupported
戻り値:
boolean マーク処理がサポートされているか返されます.
[true]が返された場合サポートされています. [false]が返された場合サポートされていません.