Home How it Works Android APIMiner IDE Version More Info

to top

Added in API level 1

public class

CipherInputStream

extends FilterInputStream

java.lang.Object
↳	java.io.InputStream
	↳	java.io.FilterInputStream
		↳	javax.crypto.CipherInputStream

Class Overview

This class wraps an InputStream and a cipher so that read() methods return data that are read from the underlying InputStream and processed by the cipher.

The cipher must be initialized for the requested operation before being used by a CipherInputStream. For example, if a cipher initialized for decryption is used with a CipherInputStream, the CipherInputStream tries to read the data an decrypt them before returning.

Summary

[Expand]

Inherited Fields

From class java.io.FilterInputStream

Public Constructors
	CipherInputStream( InputStream is, Cipher c) Creates a new `CipherInputStream` instance for an `InputStream` and a cipher.

Protected Constructors
	CipherInputStream( InputStream is) Creates a new `CipherInputStream` instance for an `InputStream` without a cipher.

Public Methods
int	available() Returns an estimated number of bytes that can be read or skipped without blocking for more input.
void	close() Closes this `CipherInputStream`, also closes the underlying input stream and call `doFinal` on the cipher object.
boolean	markSupported() Returns whether this input stream supports `mark` and `reset`, which it does not.
int	read() Reads the next byte from this cipher input stream.
int	read(byte[] buf, int off, int len) Reads the next `len` bytes from this input stream into buffer `buf` starting at offset `off`.
long	skip(long byteCount) Skips `byteCount` bytes in this stream.

[Expand]

Inherited Methods

From class java.io.FilterInputStream

int	available() Returns an estimated number of bytes that can be read or skipped without blocking for more input.
void	close() Closes this stream.
synchronized void	mark(int readlimit) Sets a mark position in this stream.
boolean	markSupported() Indicates whether this stream supports `mark()` and `reset()`.
int	read() Reads a single byte from the filtered stream and returns it as an integer in the range from 0 to 255.
int	read(byte[] buffer, int offset, int count) Reads at most `count` bytes from this stream and stores them in the byte array `buffer` starting at `offset`.
synchronized void	reset() Resets this stream to the last marked location.
long	skip(long byteCount) Skips `byteCount` bytes in this stream.

From class java.io.InputStream

int	available() Returns an estimated number of bytes that can be read or skipped without blocking for more input.
void	close() Closes this stream.
void	mark(int readlimit) Sets a mark position in this InputStream.
boolean	markSupported() Indicates whether this stream supports the `mark()` and `reset()` methods.
int	read(byte[] buffer) Equivalent to `read(buffer, 0, buffer.length)`.
abstract int	read() Reads a single byte from this stream and returns it as an integer in the range from 0 to 255.
int	read(byte[] buffer, int offset, int length) Reads at most `length` bytes from this stream and stores them in the byte array `b` starting at `offset`.
synchronized void	reset() Resets this stream to the last marked location.
long	skip(long byteCount) Skips at most `n` bytes in this stream.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface java.io.Closeable

Public Constructors

public CipherInputStream (InputStream is, Cipher c)

Added in API level 1

Creates a new CipherInputStream instance for an InputStream and a cipher.

Warning: passing a null source creates an invalid CipherInputStream. All read operations on such a stream will fail.

Parameters

is	the input stream to read data from.
c	the cipher to process the data with.

Protected Constructors

protected CipherInputStream (InputStream is)

Added in API level 1

Creates a new CipherInputStream instance for an InputStream without a cipher.

A NullCipher is created and used to process the data.

Parameters

is	the input stream to read data from.

Public Methods

public int available ()

Added in API level 1

Returns an estimated number of bytes that can be read or skipped without blocking for more input.

Note that this method provides such a weak guarantee that it is not very useful in practice.

Firstly, the guarantee is "without blocking for more input" rather than "without blocking": a read may still block waiting for I/O to complete — the guarantee is merely that it won't have to wait indefinitely for data to be written. The result of this method should not be used as a license to do I/O on a thread that shouldn't be blocked.

Secondly, the result is a conservative estimate and may be significantly smaller than the actual number of bytes available. In particular, an implementation that always returns 0 would be correct. In general, callers should only use this method if they'd be satisfied with treating the result as a boolean yes or no answer to the question "is there definitely data ready?".

Thirdly, the fact that a given number of bytes is "available" does not guarantee that a read or skip will actually read or skip that many bytes: they may read or skip fewer.

It is particularly important to realize that you must not use this method to size a container and assume that you can read the entirety of the stream without needing to resize the container. Such callers should probably write everything they read to a ByteArrayOutputStream and convert that to a byte array. Alternatively, if you're reading from a file, length() returns the current length of the file (though assuming the file's length can't change may be incorrect, reading a file is inherently racy).

The default implementation of this method in InputStream always returns 0. Subclasses should override this method if they are able to indicate the number of bytes available.

Returns

the estimated number of bytes available

Throws

IOException

public void close ()

Added in API level 1

Closes this CipherInputStream, also closes the underlying input stream and call doFinal on the cipher object.

Throws

IOException	if an error occurs.

public boolean markSupported ()

Added in API level 1

Returns whether this input stream supports mark and reset, which it does not.

Returns

false, since this input stream does not support mark and reset.

public int read ()

Added in API level 1

Reads the next byte from this cipher input stream.

Returns

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

Throws

IOException	if an error occurs.

public int read (byte[] buf, int off, int len)

Added in API level 1

Reads the next len bytes from this input stream into buffer buf starting at offset off.

if buf is null, the next len bytes are read and discarded.

Parameters

buf	the byte array in which to store the bytes read.
off	the initial position in `buffer` to store the bytes read from this stream.
len	the maximum number of bytes to store in `buffer`.

Returns

the number of bytes filled into buffer buf, or -1 of the of the stream is reached.

Throws

IOException	if an error occurs.
NullPointerException	if the underlying input stream is `null`.

public long skip (long byteCount)

Added in API level 1

Skips byteCount bytes in this stream. Subsequent calls to read will not return these bytes unless reset is used. This implementation skips byteCount bytes in the filtered stream.

Parameters

byteCount	the number of bytes to skip.

Returns

the number of bytes actually skipped.

Throws

IOException

information

No examples for this method.

Frequently called with: [Clear]

This example was provided by APIMiner.

Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.

Results

Interfaces

Classes

Exceptions

CipherInputStream

Class Overview

Summary

Public Constructors

public CipherInputStream (InputStream is, Cipher c)

Parameters

Protected Constructors

protected CipherInputStream (InputStream is)

Parameters

Public Methods

public int available ()

Returns

Throws

public void close ()

Throws

public boolean markSupported ()

Returns

public int read ()

Returns

Throws

public int read (byte[] buf, int off, int len)

Parameters

Returns

Throws

public long skip (long byteCount)

Parameters

Returns

Throws