com.openexchange.mail.json.writer

Class FolderWriter

java.lang.Object

com.openexchange.mail.json.writer.FolderWriter

public final class FolderWriter
extends java.lang.Object

FolderWriter - Writes MailFolder instances as JSON strings.

Author:

Thorben Betten

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FolderWriter.JSONArrayPutter
static class	FolderWriter.JSONObjectPutter
static interface	FolderWriter.JSONValuePutter
static class	FolderWriter.MailFolderFieldWriter

Method Summary

Methods

Modifier and Type	Method and Description
static FolderWriter.MailFolderFieldWriter[]	getMailFolderFieldWriter(int[] fields, MailConfig mailConfig, com.openexchange.tools.session.ServerSession session) Generates appropriate field writers for given mail folder fields
static FolderWriter.MailFolderFieldWriter[]	getMailFolderFieldWriter(int[] fields, MailConfig mailConfig, com.openexchange.tools.session.ServerSession session, com.openexchange.ajax.customizer.folder.AdditionalFolderFieldList additionalFields) Generates appropriate field writers for given mail folder fields
static org.json.JSONObject	writeMailFolder(int accountId, MailFolder folder, MailConfig mailConfig, com.openexchange.tools.session.ServerSession session) Writes whole folder as a JSON object

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

writeMailFolder

public static org.json.JSONObject writeMailFolder(int accountId,
                                  MailFolder folder,
                                  MailConfig mailConfig,
                                  com.openexchange.tools.session.ServerSession session)
                                           throws com.openexchange.exception.OXException

Writes whole folder as a JSON object

Parameters:

accountId - The account ID

folder - The folder to write

session - The server session

Returns:

The written JSON object

Throws:

com.openexchange.exception.OXException

getMailFolderFieldWriter

public static FolderWriter.MailFolderFieldWriter[] getMailFolderFieldWriter(int[] fields,
                                                            MailConfig mailConfig,
                                                            com.openexchange.tools.session.ServerSession session)

Generates appropriate field writers for given mail folder fields

Parameters:

fields - The fields to write

mailConfig - Current mail configuration

session - The server session

Returns:

Appropriate field writers as an array of FolderWriter.MailFolderFieldWriter

getMailFolderFieldWriter

public static FolderWriter.MailFolderFieldWriter[] getMailFolderFieldWriter(int[] fields,
                                                            MailConfig mailConfig,
                                                            com.openexchange.tools.session.ServerSession session,
                                                            com.openexchange.ajax.customizer.folder.AdditionalFolderFieldList additionalFields)

Generates appropriate field writers for given mail folder fields

Parameters:

fields - The fields to write

mailConfig - Current mail configuration

session - The server session

additionalFields - Additional fields

Returns:

Appropriate field writers as an array of FolderWriter.MailFolderFieldWriter