com.tencent.cos.xml.crypto

类 SdkFilterInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.tencent.cos.xml.crypto.SdkFilterInputStream

所有已实现的接口:

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

直接已知子类:

CipherLiteInputStream, InputSubstream, LengthCheckInputStream, ReleasableInputStream

public class SdkFilterInputStream
extends java.io.FilterInputStream
implements Releasable

Base class for COS Java SDK specific FilterInputStream.

字段概要

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

in

构造器概要

构造器

限定符	构造器和说明
protected	SdkFilterInputStream(java.io.InputStream in)

方法概要

限定符和类型	方法和说明
void	abort() Can be used to provide abortion logic prior to throwing the AbortedException.
protected void	abortIfNeeded() Aborts with subclass specific abortion logic executed if needed.
int	available() Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream.
void	close() Closes this input stream and releases any system resources associated with the stream.
protected boolean	isAborted()
void	mark(int readlimit) Marks the current position in this input stream.
boolean	markSupported() Tests if this input stream supports the mark and reset methods.
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	release() Releases the allocated resource.
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.

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

read

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

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

构造器详细资料

SdkFilterInputStream

protected SdkFilterInputStream(java.io.InputStream in)

方法详细资料

abortIfNeeded

protected final void abortIfNeeded()

Aborts with subclass specific abortion logic executed if needed. Note the interrupted status of the thread is cleared by this method.

abort

public void abort()

Can be used to provide abortion logic prior to throwing the AbortedException. If the wrapped InputStream is also an instance of this class, then it will also be aborted, otherwise this is a no-op.

isAborted

protected boolean isAborted()

read

public int read()
         throws java.io.IOException

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

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 在类中 java.io.FilterInputStream

返回:

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

抛出:

java.io.IOException - if an I/O error occurs.

另请参阅:

FilterInputStream.in

read

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

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

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 在类中 java.io.FilterInputStream

参数:

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 an I/O error occurs.

另请参阅:

FilterInputStream.in

skip

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

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

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 在类中 java.io.FilterInputStream

参数:

n - the number of bytes to be skipped.

返回:

the actual number of bytes skipped.

抛出:

java.io.IOException - if the stream does not support seek, or if some other I/O error occurs.

available

public int available()
              throws java.io.IOException

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

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream. The next caller might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

This method returns the result of in.available().

覆盖:

available 在类中 java.io.FilterInputStream

返回:

an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking.

抛出:

java.io.IOException - if an I/O error occurs.

close

public void close()
           throws java.io.IOException

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

Closes this input stream and releases any system resources associated with the stream. This method simply performs in.close().

指定者:

close 在接口中 java.io.Closeable

指定者:

close 在接口中 java.lang.AutoCloseable

覆盖:

close 在类中 java.io.FilterInputStream

抛出:

java.io.IOException - if an I/O error occurs.

另请参阅:

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 在类中 java.io.FilterInputStream

参数:

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 在类中 java.io.FilterInputStream

抛出:

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

另请参阅:

FilterInputStream.in, FilterInputStream.mark(int)

markSupported

public boolean markSupported()

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

Tests if this input stream supports the mark and reset methods. This method simply performs in.markSupported().

覆盖:

markSupported 在类中 java.io.FilterInputStream

返回:

true if this stream type supports the mark and reset method; false otherwise.

另请参阅:

FilterInputStream.in, InputStream.mark(int), InputStream.reset()

release

public void release()

从接口复制的说明: Releasable

Releases the allocated resource. This method should not be called except by the caller who allocated the resource at the very top of the call stack. This allows, typically, a Closeable resource to be not unintentionally released owing to the calling of the Closeable.close() methods by implementation deep down in the call stack.

For example, the creation of a ResettableInputStream would entail physically opening a file. If the opened file is meant to be closed only (in a finally block) by the very same code block that created it, then it is necessary that the release method must not be called while the execution is made in other stack frames. In such case, as other stack frames may inadvertently or indirectly call the close method of the stream, the creator of the stream would need to explicitly disable the accidental closing via ResettableInputStream#disableClose(), so that the release method becomes the only way to truly close the opened file.

指定者:

release 在接口中 Releasable