org.dishevelled.matrix.io

Interface Matrix3DWriter<E>

Type Parameters:

E - 3D matrix element type

All Known Implementing Classes:

AbstractMatrix3DWriter, TextMatrix3DWriter, ValuesMatrix3DWriter

public interface Matrix3DWriter<E>

Writer for matrices of objects in three dimensions.

Version:

$Revision$ $Date$

Author:

Michael Heuer

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Appendable> T	append(Matrix3D<? extends E> matrix, T appendable) Append the specified 3D matrix to the specified appendable.
void	write(Matrix3D<? extends E> matrix, File file) Write the specified 3D matrix to the specified file.
void	write(Matrix3D<? extends E> matrix, OutputStream outputStream) Write the specified 3D matrix to the specified output stream.

Method Detail

append

<T extends Appendable> T append(Matrix3D<? extends E> matrix,
                              T appendable)
                            throws IOException

Append the specified 3D matrix to the specified appendable.

Type Parameters:

T - extends Appendable

Parameters:

matrix - 3D matrix to append, must not be null

appendable - appendable to append the specified 3D matrix to, must not be null

Returns:

the specified appendable with the specified 3D matrix appended

Throws:

IOException - if an IO error occurs

write

void write(Matrix3D<? extends E> matrix,
         File file)
           throws IOException

Write the specified 3D matrix to the specified file.

Parameters:

matrix - 3D matrix to write, must not be null

file - file to write to, must not be null

Throws:

IOException - if an IO error occurs

write

void write(Matrix3D<? extends E> matrix,
         OutputStream outputStream)
           throws IOException

Write the specified 3D matrix to the specified output stream.

Parameters:

matrix - 3D matrix to write, must not be null

outputStream - output stream to write to, must not be null

Throws:

IOException - if an IO error occurs