Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)

Added in API level 1

public class

CipherOutputStream

extends FilterOutputStream

java.lang.Object
↳	java.io.OutputStream
	↳	java.io.FilterOutputStream
		↳	javax.crypto.CipherOutputStream

Class Overview

This class wraps an output stream and a cipher so that write methods send the data through the cipher before writing them to the underlying output stream.

The cipher must be initialized for the requested operation before being used by a CipherOutputStream . For example, if a cipher initialized for encryption is used with a CipherOutputStream , the CipherOutputStream tries to encrypt the data writing it out.

Summary

[Expand]

Inherited Fields

From class java.io.FilterOutputStream

Public Constructors
	CipherOutputStream ( OutputStream os, Cipher c) Creates a new `CipherOutputStream` instance for an `OutputStream` and a `Cipher` .

Protected Constructors
	CipherOutputStream ( OutputStream os) Creates a new `CipherOutputStream` instance for an `OutputStream` without a cipher.

Public Methods
void	close () Close this cipher output stream.
void	flush () Flushes this cipher output stream.
void	write (byte[] b, int off, int len) Writes the `len` bytes from buffer `b` starting at offset `off` to this cipher output stream.
void	write (int b) Writes the single byte to this cipher output stream.

[Expand]

Inherited Methods

From class java.io.FilterOutputStream

From class java.io.OutputStream

void	close () Closes this stream.
void	flush () Flushes this stream.
void	write (byte[] buffer, int offset, int count) Writes `count` bytes from the byte array `buffer` starting at position `offset` to this stream.
void	write (byte[] buffer) Equivalent to `write(buffer, 0, buffer.length)` .
abstract void	write (int oneByte) Writes a single byte to 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

From interface java.io.Flushable

From interface java.lang.AutoCloseable

Public Constructors

public CipherOutputStream ( OutputStream os, Cipher c)

Added in API level 1

Creates a new CipherOutputStream instance for an OutputStream and a Cipher .

Parameters

os	the output stream to write data to.
c	the cipher to process the data with.

Protected Constructors

protected CipherOutputStream ( OutputStream os)

Added in API level 1

Creates a new CipherOutputStream instance for an OutputStream without a cipher.

A NullCipher is created to process the data.

Parameters

os	the output stream to write the data to.

Public Methods

public void close ()

Added in API level 1

Close this cipher output stream.

On the underlying cipher doFinal will be invoked, and any buffered bytes from the cipher are also written out, and the cipher is reset to its initial state. The underlying output stream is also closed.

Throws

IOException	if an error occurs.

public void flush ()

Added in API level 1

Flushes this cipher output stream.

Throws

IOException	if an error occurs

public void write (byte[] b, int off, int len)

Added in API level 1

Writes the len bytes from buffer b starting at offset off to this cipher output stream.

Parameters

b	the buffer.
off	the offset to start at.
len	the number of bytes.

Throws

IOException	if an error occurs.

public void write (int b)

Added in API level 1

Writes the single byte to this cipher output stream.

Parameters

b	the byte to write.

Throws

IOException	if an error occurs.

Results

Interfaces

Classes

Exceptions

CipherOutputStream

Class Overview

Summary

Public Constructors

public CipherOutputStream ( OutputStream os, Cipher c)

Parameters

Protected Constructors

protected CipherOutputStream ( OutputStream os)

Parameters

Public Methods

public void close ()

Throws

public void flush ()

Throws

public void write (byte[] b, int off, int len)

Parameters

Throws

public void write (int b)

Parameters

Throws