uk.ac.ed.epcc.webapp.model.data.stream

Interface StreamData

All Known Subinterfaces:

MimeStreamData

All Known Implementing Classes:

BlobStreamData, ByteArrayMimeStreamData, ByteArrayStreamData, FileItemStreamData, FileStreamData, MimeStreamDataWrapper, PartStreamData, RequestMimeStreamData

public interface StreamData

Interface implemented by Objects that can provide their data as a Stream

Method Summary

Modifier and Type	Method and Description
default void	append(java.io.OutputStream out) write contents to an OutputStream without closing.
java.io.InputStream	getInputStream() get an InputStream to read the state of the obect
long	getLength() get the size of data held in the object
java.io.OutputStream	getOutputStream() Get an OutputStream used to modify the state of the object
default void	read(java.io.InputStream in) read data from an Input Stream
default void	write(java.io.OutputStream out) write contents to an OutputStream and close

Method Detail

getLength

long getLength()

get the size of data held in the object

Returns:

long size of current data

getInputStream

java.io.InputStream getInputStream()

get an InputStream to read the state of the obect

Returns:

InputStream

getOutputStream

java.io.OutputStream getOutputStream()

Get an OutputStream used to modify the state of the object

Returns:

OutPutStream

read

default void read(java.io.InputStream in)
           throws DataFault,
                  java.io.IOException

read data from an Input Stream

Parameters:

in - InputStream

Throws:

DataFault

java.io.IOException

write

default void write(java.io.OutputStream out)
            throws DataFault,
                   java.io.IOException

write contents to an OutputStream and close

Parameters:

out - OutputStream

Throws:

DataFault

java.io.IOException

append

default void append(java.io.OutputStream out)
             throws DataFault,
                    java.io.IOException

write contents to an OutputStream without closing.

Parameters:

out - OutputStream

Throws:

DataFault

java.io.IOException