com.google.sitebricks.client

Interface Transport

All Known Implementing Classes:

JacksonJsonTransport, Json, Raw, Text, Xml

public interface Transport

Author:

Dhanji R. Prasanna (dhanji@gmail.com)

Method Summary

Methods

Modifier and Type	Method and Description
String	contentType() Returns the HTTP content type marshalled by this transport.
<T> T	in(InputStream in, Class<T> type) Reads from a given inputstream and returns an object representing the unmarshalled form of the underlying protocol data.
<T> T	in(InputStream in, com.google.inject.TypeLiteral<T> type) Reads from a given inputstream and returns an object representing the unmarshalled form of the underlying protocol data.
<T> void	out(OutputStream out, Class<T> type, T data) Converts a given object into transportable data and writes it to the provided OutputStream.

Method Detail

in

<T> T in(InputStream in,
       Class<T> type)
     throws IOException

Reads from a given inputstream and returns an object representing the unmarshalled form of the underlying protocol data.

Parameters:

in - An inputstream to read data from. This stream will NOT be closed by the implementation of this interface.

type - The type to read in. The method will return an instance of this type representing the data in the in stream.

Returns:

An instance of type representing the data in the provided stream.

Throws:

IOException - Thrown if there is an error reading from this stream.

in

<T> T in(InputStream in,
       com.google.inject.TypeLiteral<T> type)
     throws IOException

Reads from a given inputstream and returns an object representing the unmarshalled form of the underlying protocol data.

Parameters:

in - An inputstream to read data from. This stream will NOT be closed by the implementation of this interface.

type - The TypeLiteral which is representing a generic type to read in. The method will return an instance of the generic type representing the data in the in stream.

Returns:

An instance of type representing the data in the provided stream.

Throws:

IOException - Thrown if there is an error reading from this stream.

out

<T> void out(OutputStream out,
           Class<T> type,
           T data)
         throws IOException

Converts a given object into transportable data and writes it to the provided OutputStream.

Parameters:

out - An open outputstream to write to. This stream will NOT be closed.

type - The type of the data being serialized to the stream.

data - An object representing the data to be written out.

Throws:

IOException - Thrown if there is an error writing to this stream.

contentType

String contentType()

Returns the HTTP content type marshalled by this transport. For example, the Text transport transforms plain strings to and from the HTTP stream. Its content type is text/plain. This is only a default (or suggested) content type. You may of course, return whatever content type is most suitable if using this transport to deliver web responses.

Returns:

A non-empty string representing a HTTP content (mime) type.