FileInputStream クラス

パッケージ:

com.microsoft.azure.storage.file

• java.lang.Object
• • InputStream
  • • com.microsoft.azure.storage.file.FileInputStream

public class FileInputStream

指定されたファイル リソースを読み取る入力ストリームを提供します。

コンストラクターの概要

コンストラクター	説明
FileInputStream(final CloudFile parentFile, final AccessCondition accessCondition, final FileRequestOptions options, final OperationContext opContext)	FileInputStream クラスの新しいインスタンスを初期化します。

メソッドの概要

修飾子と型	メソッドと説明
synchronized int	available() この入力ストリームに対するメソッドの次の呼び出しによってブロックすることなく、この入力ストリームから読み取ることができる (またはスキップされる) バイト数の推定値を返します。 次の呼び出しは、同じスレッドまたは別のスレッドである可能性があります。 この多くのバイトを 1 回読み取ったりスキップしたりしてもブロックされませんが、読み取りまたはスキップするバイト数が少なくなる場合があります。
synchronized void	close() この入力ストリームを閉じ、ストリームに関連付けられているシステム リソースを解放します。
synchronized void	mark(final int readlimit) この入力ストリーム内の現在位置をマークします。 reset メソッドの後続の呼び出しでは、このストリームが最後にマークされた位置に再配置され、後続の読み取りで同じバイトが再読み取りされます。
boolean	markSupported() この入力ストリームで mark メソッドと reset メソッドがサポートされているかどうかをテストします。 マークとリセットがサポートされているかどうかは、特定の入力ストリーム インスタンスの不変プロパティです。 の markSupported メソッド InputStream は false を返します。
int	read() 入力ストリームから次のバイトのデータを読み取ります。 値 byte は、0 から 255 の範囲の int として返されます。 ストリームの末尾に達したために使用可能なバイトがない場合は、値 -1 が返されます。 このメソッドは、入力データが使用可能になるまで、ストリームの末尾が検出されるか、例外がスローされるまでブロックします。
int	read(final byte[] b) 入力ストリームからバイト数を読み取り、バッファー配列 に格納します。 実際に読み取られたバイト数は整数として返されます。 このメソッドは、入力データが使用可能か、ファイルの終わりが検出されるか、例外がスローされるまでブロックします。 の長さが 0 の場合、バイトは読み取られず、0 が返されます。それ以外の場合は、少なくとも 1 バイトを読み取ろうとします。 ストリームがファイルの末尾にあるためにバイトが使用できない場合は、値 -1 が返されます。それ以外の場合は、少なくとも 1 バイトが読み取られ、 に格納されます。 最初のバイト読み取りは 要素に格納され、次のバイトは に格納されます。 読み取られたバイト数は、最大で の長さと同じです。 実際に読み取られたバイト数を指定します。これらのバイトは を介して要素に格納され、要素は影響を受けません。 クラス InputStream の メソッドは、次と同じ効果を持ちます。
int	read(final byte[] b, final int off, final int len) 入力ストリームからバイト配列に最大バイトのデータを読み取ります。 バイト数の読み取りが試行されますが、読み取られる数は少ない場合があります。 実際に読み取られたバイト数は整数として返されます。 このメソッドは、入力データが使用可能か、ファイルの終わりが検出されるか、例外がスローされるまでブロックします。 が 0 の場合、バイトは読み取られず、0 が返されます。それ以外の場合は、少なくとも 1 バイトを読み取ろうとします。 ストリームがファイルの末尾にあるためにバイトが使用できない場合は、値 -1 が返されます。それ以外の場合は、少なくとも 1 バイトが読み取られ、 に格納されます。 最初のバイト読み取りは 要素に格納され、次のバイトは に格納されます。 読み取られたバイト数は、最大で と同じです。 実際に読み取られたバイト数を指定します。これらのバイトは を介して要素に格納され、要素は影響を受けません。 いずれの場合も、through 要素と through 要素は影響を受けません。 クラス InputStream の メソッドは、単に メソッドを繰り返し呼び出します。 このような最初の呼び出しの結果が の場合、その例外は メソッドの呼び出しから返されます。 に対する後続の呼び出しによって が発生した場合、例外がキャッチされ、ファイルの末尾であるかのように処理されます。その時点まで読み取られたバイトが に格納され、例外が発生するまでに読み取られたバイト数が返されます。 このメソッドの既定の実装では、要求された量の入力データが読み取られるか、ファイルの終わりが検出されるか、例外がスローされるまでブロックされます。 サブクラスは、このメソッドのより効率的な実装を提供することをお勧めします。
synchronized void	reset() このストリームを、この入力ストリームで mark メソッドが最後に呼び出された時点の位置に再配置します。 ファイル読み取りストリームの位置を変更すると、ファイル MD5 チェックが無効になります。
synchronized long	skip(final long n) この入力ストリームから n バイトのデータをスキップして破棄します。 skip メソッドでは、さまざまな理由により、バイト数が少なくなり、0 になる可能性があります。 これは、いくつかの条件のいずれかに起因する可能性があります。n バイトがスキップされる前にファイルの末尾に到達する可能性は 1 つだけです。 スキップされた実際のバイト数が返されます。 n が負の場合、バイトはスキップされません。 ファイル読み取りストリームの位置を変更すると、ファイル MD5 チェックが無効になります。

コンストラクターの詳細

FileInputStream

protected FileInputStream(final CloudFile parentFile, final AccessCondition accessCondition, final FileRequestOptions options, final OperationContext opContext)

FileInputStream クラスの新しいインスタンスを初期化します。

Parameters:

parentFile - CloudFileこのストリームが関連付けられているファイルを表す オブジェクト。

accessCondition - AccessConditionファイルのアクセス条件を表す オブジェクト。

options - FileRequestOptions要求の追加オプションを指定する を表す オブジェクト。

opContext - 操作の OperationContext 実行を追跡するために使用される オブジェクト。

Throws:

StorageException - 操作中に発生したエラーを表す例外。

メソッドの詳細

available

public synchronized int available()

この入力ストリームに対するメソッドの次の呼び出しによってブロックすることなく、この入力ストリームから読み取ることができる (またはスキップされる) バイト数の推定値を返します。 次の呼び出しは、同じスレッドまたは別のスレッドである可能性があります。 この多くのバイトを 1 回読み取ったりスキップしたりしてもブロックされませんが、読み取りまたはスキップするバイト数が少なくなる場合があります。

Returns:

intブロックせずにこの入力ストリームから読み取ることができる (またはスキップされる) バイト数の見積もりを表す 。入力ストリームの末尾に達した場合は 0 を表す 。

Throws:

IOException - I/O エラーが発生した場合。

close

public synchronized void close()

この入力ストリームを閉じ、ストリームに関連付けられているシステム リソースを解放します。

Throws:

IOException - I/O エラーが発生した場合。

mark

public synchronized void mark(final int readlimit)

この入力ストリーム内の現在位置をマークします。 reset メソッドの後続の呼び出しでは、このストリームが最後にマークされた位置に再配置され、後続の読み取りで同じバイトが再読み取りされます。

Parameters:

readlimit - intマーク位置が無効になる前に読み取ることができるバイトの上限を表す 。

markSupported

public boolean markSupported()

この入力ストリームで mark メソッドと reset メソッドがサポートされているかどうかをテストします。 マークとリセットがサポートされているかどうかは、特定の入力ストリーム インスタンスの不変プロパティです。 の markSupported メソッド InputStream は false を返します。

Returns:

True このストリーム インスタンスが mark メソッドと reset メソッドをサポートしている場合は 。 False それ以外の場合は 。

read

public int read()

入力ストリームから次のバイトのデータを読み取ります。 値 byte は、0 から 255 の範囲の int として返されます。 ストリームの末尾に達したために使用可能なバイトがない場合は、値 -1 が返されます。 このメソッドは、入力データが使用可能になるまで、ストリームの末尾が検出されるか、例外がスローされるまでブロックします。

Returns:

intバッファーに読み込まれた合計バイト数を表す 。ストリームの末尾に達したためにデータが存在しない場合は -1。

Throws:

IOException - I/O エラーが発生した場合。

read

public int read(final byte[] b)

入力ストリームからバイト数を読み取り、バッファー配列 に格納します。 実際に読み取られたバイト数は整数として返されます。 このメソッドは、入力データが使用可能か、ファイルの終わりが検出されるか、例外がスローされるまでブロックします。 の長さが 0 の場合、バイトは読み取られず、0 が返されます。それ以外の場合は、少なくとも 1 バイトを読み取ろうとします。 ストリームがファイルの末尾にあるためにバイトが使用できない場合は、値 -1 が返されます。それ以外の場合は、少なくとも 1 バイトが読み取られ、 に格納されます。

最初のバイト読み取りは 要素に格納され、次のバイトは に格納されます。 読み取られたバイト数は、最大で の長さと同じです。 実際に読み取られたバイト数を指定します。これらのバイトは を介して要素に格納され、要素は影響を受けません。

クラス InputStream の メソッドは、次と同じ効果を持ちます。

Parameters:

b - byteデータの読み取り先となるバッファーを表す配列。

Throws:

IOException - ファイルの末尾以外の理由で最初のバイトを読み取ることができない場合、入力ストリームが閉じている場合、または他の I/O エラーが発生した場合。

NullPointerException - 配列bが byte null の場合。

read

public int read(final byte[] b, final int off, final int len)

入力ストリームからバイト配列に最大バイトのデータを読み取ります。 バイト数の読み取りが試行されますが、読み取られる数は少ない場合があります。 実際に読み取られたバイト数は整数として返されます。 このメソッドは、入力データが使用可能か、ファイルの終わりが検出されるか、例外がスローされるまでブロックします。

が 0 の場合、バイトは読み取られず、0 が返されます。それ以外の場合は、少なくとも 1 バイトを読み取ろうとします。 ストリームがファイルの末尾にあるためにバイトが使用できない場合は、値 -1 が返されます。それ以外の場合は、少なくとも 1 バイトが読み取られ、 に格納されます。

最初のバイト読み取りは 要素に格納され、次のバイトは に格納されます。 読み取られたバイト数は、最大で と同じです。 実際に読み取られたバイト数を指定します。これらのバイトは を介して要素に格納され、要素は影響を受けません。

いずれの場合も、through 要素と through 要素は影響を受けません。

クラス InputStream の メソッドは、単に メソッドを繰り返し呼び出します。 このような最初の呼び出しの結果が の場合、その例外は メソッドの呼び出しから返されます。 に対する後続の呼び出しによって が発生した場合、例外がキャッチされ、ファイルの末尾であるかのように処理されます。その時点まで読み取られたバイトが に格納され、例外が発生するまでに読み取られたバイト数が返されます。 このメソッドの既定の実装では、要求された量の入力データが読み取られるか、ファイルの終わりが検出されるか、例外がスローされるまでブロックされます。 サブクラスは、このメソッドのより効率的な実装を提供することをお勧めします。

Parameters:

b - byteデータの読み取り先となるバッファーを表す配列。

off - intデータが書き込まれる配列のbyte開始オフセットを表す 。

len - int読み取る最大バイト数を表す 。

Returns:

intバッファーに読み込まれた合計バイト数を表す 。ストリームの末尾に達したためにデータが存在しない場合は -1。

Throws:

IOException - ファイルの終わり以外の理由で最初のバイトを読み取ることができない場合、または入力ストリームが閉じている場合、または他の I/O エラーが発生した場合。

NullPointerException - 配列bが byte null の場合。

IndexOutOfBoundsException - が負の場合、len負の値、または len が よりb.length - off大きい場合off。

reset

public synchronized void reset()

このストリームを、この入力ストリームで mark メソッドが最後に呼び出された時点の位置に再配置します。 ファイル読み取りストリームの位置を変更すると、ファイル MD5 チェックが無効になります。

Throws:

IOException - このストリームがマークされていない場合、またはマークが無効になっている場合。

skip

public synchronized long skip(final long n)

この入力ストリームから n バイトのデータをスキップして破棄します。 skip メソッドでは、さまざまな理由により、バイト数が少なくなり、0 になる可能性があります。 これは、いくつかの条件のいずれかに起因する可能性があります。n バイトがスキップされる前にファイルの末尾に到達する可能性は 1 つだけです。 スキップされた実際のバイト数が返されます。 n が負の場合、バイトはスキップされません。

ファイル読み取りストリームの位置を変更すると、ファイル MD5 チェックが無効になります。

Parameters:

n - longスキップするバイト数を表す 。