com.hannesdorfmann.httpkit.parser

Interface ParserWriter<T>

Type Parameters:

T - The type of the real object that will be parsed

public interface ParserWriter<T>

A ParserWriter can "parse" a InputStream into a real object and vice versa (write an Object to the original data format, like json, xml or evene binary image data etc.)

Author:

Hannes Dorfmann

Field Summary

Fields

Modifier and Type	Field and Description
static int	COLLECTION_TYPE_LIST Indicates, that the result of the parsing process should be returned as List. the default List implementation is ArrayList
static int	COLLECTION_TYPE_NONE Indicates that the collection type should not be used while parsing, and return a single class instance instead of a collection like List, Map, etc ...

Method Summary

Methods

Modifier and Type	Method and Description
T	parse(InputStream in, Class<?> targetClass, int collectionType, String mimeType, String charset) Take a InputStream and parse it to a "real" object
void	write(OutputStream out, T value, String mimeType, String charset) This method writes the passed oject to an outputstream
void	writeRaw(OutputStream out, byte[] value, String mimeType, String charset) Write the data as raw bytes

Field Detail

COLLECTION_TYPE_NONE

static final int COLLECTION_TYPE_NONE

Indicates that the collection type should not be used while parsing, and return a single class instance instead of a collection like List, Map, etc ...

See Also:

Constant Field Values

COLLECTION_TYPE_LIST

static final int COLLECTION_TYPE_LIST

Indicates, that the result of the parsing process should be returned as List. the default List implementation is ArrayList

See Also:

Constant Field Values

Method Detail

parse

T parse(InputStream in,
      Class<?> targetClass,
      int collectionType,
      String mimeType,
      String charset)
        throws Exception

Take a InputStream and parse it to a "real" object

Parameters:

in - The InputStream

targetClass - The Target class the data should be parsed in. Normally only used if json or xml should be parsed.

collectionType - Here you specify which kind o

mimeType - The mimeType, because for example a image parser can parse JPG and PNG and GIF in the same procedure

charset - The charset that is used for string text encoding. For binary data this parameter is useless and can be ingnored

Throws:

Exception

write

void write(OutputStream out,
         T value,
         String mimeType,
         String charset)
           throws Exception

This method writes the passed oject to an outputstream

Parameters:

out -

value -

mimeType - the mime type that should be written

charset - The charset that is used for string text encoding. For binary data this parameter is useless and can be ingnored

Throws:

Exception

writeRaw

void writeRaw(OutputStream out,
            byte[] value,
            String mimeType,
            String charset)
              throws IOException

Write the data as raw bytes

Parameters:

out -

value -

mimeType -

charset -

Throws:

IOException