ball.activation

Interface DataSourceDefaultMethods

All Superinterfaces:

DataSource

All Known Implementing Classes:

AbstractDataSource, ByteArrayDataSource, FilterDataSource, HDHRRecording, JAXBDataSource, ReaderWriterDataSource, TempFileDataSource, TextTable, ThrowableDataSource

public interface DataSourceDefaultMethods
extends DataSource

DataSource default method implementations.

Version:

$Revision: 5285 $

Author:

Allen D. Ball

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLICATION_OCTET_STREAM RFC2045 "application/octet-stream"
static String	APPLICATION_XML RFC3023 "application/xml"
static String	CONTENT_TYPE RFC2045 "Content-Type"
static String	TEXT_HTML RFC2045 "text/html"
static String	TEXT_PLAIN RFC2045 "text/plain"

Method Summary

Modifier and Type	Method and Description
default void	clear() Method to clear the DataSource and discard any input on any open getOutputStream().
default InputStream	getInputStream()
default InputStream	getInputStream(Class<?>... types) Method to "wrap" the InputStream returned by getInputStream()into InputStream instances.
default OutputStream	getOutputStream()
default OutputStream	getOutputStream(Class<?>... types) Method to "wrap" the OutputStream returned by getOutputStream()into OutputStream instances.
default long	length() Method to get the number of bytes stored in this DataSource.
default void	setContentType(String type)
default void	setName(String name)
default InputStream	wrap(InputStream in, Class<?>... types) Method to "wrap" an InputStream into InputStream instances.
default OutputStream	wrap(OutputStream out, Class<?>... types) Method to "wrap" an OutputStream into OutputStream instances.
default void	writeTo(OutputStream out) Method to write the contents of this DataSource to an OutputStream.

Methods inherited from interface javax.activation.DataSource

getContentType, getName

Field Detail

CONTENT_TYPE

static final String CONTENT_TYPE

RFC2045 "Content-Type"

See Also:

Constant Field Values

APPLICATION_OCTET_STREAM

static final String APPLICATION_OCTET_STREAM

RFC2045 "application/octet-stream"

See Also:

Constant Field Values

APPLICATION_XML

static final String APPLICATION_XML

RFC3023 "application/xml"

See Also:

Constant Field Values

TEXT_PLAIN

static final String TEXT_PLAIN

RFC2045 "text/plain"

See Also:

Constant Field Values

TEXT_HTML

static final String TEXT_HTML

RFC2045 "text/html"

See Also:

Constant Field Values

Method Detail

setName

default void setName(String name)

setContentType

default void setContentType(String type)

getInputStream

default InputStream getInputStream()
                            throws IOException

Specified by:

getInputStream in interface DataSource

Throws:

UnsupportedOperationException - Unless overridden by subclass implementation.

IOException

getOutputStream

default OutputStream getOutputStream()
                              throws IOException

Specified by:

getOutputStream in interface DataSource

Throws:

UnsupportedOperationException - Unless overridden by subclass implementation.

IOException

clear

default void clear()

Method to clear the DataSource and discard any input on any open getOutputStream().

Throws:

UnsupportedOperationException - If getOutputStream() throws UnsupportedOperationException.

length

default long length()

Method to get the number of bytes stored in this DataSource. Default implementation returns -1.

Returns:

The number of bytes stored in this DataSource; -1 if the count is unknown.

getInputStream

default InputStream getInputStream(Class<?>... types)
                            throws IOException

Method to "wrap" the InputStream returned by getInputStream()into InputStream instances.

Parameters:

types - The InputStream implementation Classes.

Returns:

The "wrapped" InputStream.

Throws:

IOException - If an I/O error occurs.

getOutputStream

default OutputStream getOutputStream(Class<?>... types)
                              throws IOException

Method to "wrap" the OutputStream returned by getOutputStream()into OutputStream instances.

Parameters:

types - The OutputStream implementation Classes.

Returns:

The "wrapped" OutputStream.

Throws:

IOException - If an I/O error occurs.

writeTo

default void writeTo(OutputStream out)
              throws IOException

Method to write the contents of this DataSource to an OutputStream.

Parameters:

out - The target OutputStream.

Throws:

IOException - If a problem is encountered opening or reading the InputStream or writing to the OutputStream.

See Also:

getInputStream()

wrap

default InputStream wrap(InputStream in,
                         Class<?>... types)
                  throws IOException

Method to "wrap" an InputStream into InputStream instances.

Parameters:

in - The InputStream.

types - The InputStream implementation Classes.

Returns:

The "wrapped" InputStream.

Throws:

IOException - If any of the wrapping streams throw an IOException.

wrap

default OutputStream wrap(OutputStream out,
                          Class<?>... types)
                   throws IOException

Method to "wrap" an OutputStream into OutputStream instances.

Parameters:

out - The OutputStream.

types - The OutputStream implementation Classes.

Returns:

The "wrapped" OutputStream.

Throws:

IOException - If any of the wrapping streams throw an IOException.