com.tencent.cos.xml.crypto

类 LengthCheckInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.tencent.cos.xml.crypto.SdkFilterInputStream

com.tencent.cos.xml.crypto.LengthCheckInputStream

所有已实现的接口:

Releasable, java.io.Closeable, java.lang.AutoCloseable

public class LengthCheckInputStream
extends SdkFilterInputStream

字段概要

字段

限定符和类型	字段和说明
static boolean	EXCLUDE_SKIPPED_BYTES
static boolean	INCLUDE_SKIPPED_BYTES

从类继承的字段 java.io.FilterInputStream

in

构造器概要

构造器

构造器和说明
LengthCheckInputStream(java.io.InputStream in, long expectedLength, boolean includeSkipped) Constructs an input stream that performs length check to ensure the number of bytes read from the underlying input stream is the same as the expected total.

方法概要

限定符和类型	方法和说明
void	mark(int readlimit) Marks the current position in this input stream.
int	read() Reads the next byte of data from this input stream.
int	read(byte[] b, int off, int len) Reads up to len bytes of data from this input stream into an array of bytes.
void	reset() Repositions this stream to the position at the time the mark method was last called on this input stream.
long	skip(long n) Skips over and discards n bytes of data from the input stream.

从类继承的方法 com.tencent.cos.xml.crypto.SdkFilterInputStream

abort, abortIfNeeded, available, close, isAborted, markSupported, release

从类继承的方法 java.io.FilterInputStream

read

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

INCLUDE_SKIPPED_BYTES

public static final boolean INCLUDE_SKIPPED_BYTES

另请参阅:

常量字段值

EXCLUDE_SKIPPED_BYTES

public static final boolean EXCLUDE_SKIPPED_BYTES

另请参阅:

常量字段值

构造器详细资料

LengthCheckInputStream

public LengthCheckInputStream(java.io.InputStream in,
                              long expectedLength,
                              boolean includeSkipped)

Constructs an input stream that performs length check to ensure the number of bytes read from the underlying input stream is the same as the expected total.

参数:

in - the underlying input stream

expectedLength - the total length of the data in bytes expected to be read from the underlying input stream; must be non-negative.

includeSkipped - true if bytes skipped are to be considered as part of the data length; false otherwise. Typically, this parameter should be set to false for uploading data to COS, but set to true for receiving data from COS.

方法详细资料

read

public int read()
         throws java.io.IOException

Reads the next byte of data from this input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

This method simply performs in.read() and returns the result.

覆盖:

read 在类中 SdkFilterInputStream

返回:

the next byte of data, or -1 if the end of the stream is reached.

抛出:

java.io.IOException - if the data length read has exceeded the expected total, or if the total data length is not the same as the expected total.

另请参阅:

FilterInputStream.in

read

public int read(byte[] b,
                int off,
                int len)
         throws java.io.IOException

Reads up to len bytes of data from this input stream into an array of bytes. If len is not zero, the method blocks until some input is available; otherwise, no bytes are read and 0 is returned.

This method simply performs in.read(b, off, len) and returns the result.

覆盖:

read 在类中 SdkFilterInputStream

参数:

b - the buffer into which the data is read.

off - the start offset in the destination array b

len - the maximum number of bytes read.

返回:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

抛出:

java.io.IOException - if the data length read has exceeded the expected total, or if the total data length is not the same as the expected total.

另请参阅:

FilterInputStream.in

mark

public void mark(int readlimit)

从类复制的说明: java.io.FilterInputStream

Marks the current position in this input stream. A subsequent call to the reset method repositions this stream at the last marked position so that subsequent reads re-read the same bytes.

The readlimit argument tells this input stream to allow that many bytes to be read before the mark position gets invalidated.

This method simply performs in.mark(readlimit).

覆盖:

mark 在类中 SdkFilterInputStream

参数:

readlimit - the maximum limit of bytes that can be read before the mark position becomes invalid.

另请参阅:

FilterInputStream.in, FilterInputStream.reset()

reset

public void reset()
           throws java.io.IOException

从类复制的说明: java.io.FilterInputStream

Repositions this stream to the position at the time the mark method was last called on this input stream.

This method simply performs in.reset().

Stream marks are intended to be used in situations where you need to read ahead a little to see what's in the stream. Often this is most easily done by invoking some general parser. If the stream is of the type handled by the parse, it just chugs along happily. If the stream is not of that type, the parser should toss an exception when it fails. If this happens within readlimit bytes, it allows the outer code to reset the stream and try another parser.

覆盖:

reset 在类中 SdkFilterInputStream

抛出:

java.io.IOException - if the stream has not been marked or if the mark has been invalidated.

另请参阅:

FilterInputStream.in, FilterInputStream.mark(int)

skip

public long skip(long n)
          throws java.io.IOException

Skips over and discards n bytes of data from the input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. The actual number of bytes skipped is returned.

This method simply performs in.skip(n).

覆盖:

skip 在类中 SdkFilterInputStream

参数:

n - the number of bytes to be skipped.

返回:

the actual number of bytes skipped.

抛出:

java.io.IOException - if includeSkipped is true and the data length skipped has exceeded the expected total.