com.openexchange.mail.json

Class MailRequest

java.lang.Object

com.openexchange.mail.json.MailRequest

public final class MailRequest
extends java.lang.Object

MailRequest

Author:

Thorben Betten

Field Summary

Fields

Modifier and Type	Field and Description
static int	NOT_FOUND Constant for not-found number.

Constructor Summary

Constructors

Constructor and Description
MailRequest(com.openexchange.ajax.requesthandler.AJAXRequestData request, com.openexchange.tools.session.ServerSession session) Initializes a new MailRequest.

Method Summary

Methods

Modifier and Type	Method and Description
int[]	checkIntArray(java.lang.String name) Checks for presence of comma-separated int list.
java.lang.String	checkParameter(java.lang.String name) Gets the value mapped to given parameter name.
java.lang.String[]	checkStringArray(java.lang.String name) Checks for presence of comma-separated String list.
long	getMax() Gets the max parameter.
java.lang.String	getParameter(java.lang.String name) Gets the value mapped to given parameter name.
com.openexchange.ajax.requesthandler.AJAXRequestData	getRequest() Gets the request.
com.openexchange.tools.session.ServerSession	getSession() Gets the session.
boolean	optBool(java.lang.String name) Gets optional boolean parameter.
boolean	optBool(java.lang.String name, boolean def) Gets optional boolean parameter.
int	optInt(java.lang.String name) Gets optional int parameter.
java.lang.String[]	optStringArray(java.lang.String name) Checks for presence of comma-separated String list.

Methods inherited from class java.lang.Object

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

Field Detail

NOT_FOUND

public static final int NOT_FOUND

Constant for not-found number.

See Also:

Constant Field Values

Constructor Detail

MailRequest

public MailRequest(com.openexchange.ajax.requesthandler.AJAXRequestData request,
           com.openexchange.tools.session.ServerSession session)

Initializes a new MailRequest.

Parameters:

session - The session

request - The request

Method Detail

getMax

public long getMax()
            throws com.openexchange.exception.OXException

Gets the max parameter.

Returns:

The max parameter

Throws:

com.openexchange.exception.OXException - If max is not a number

checkParameter

public java.lang.String checkParameter(java.lang.String name)
                                throws com.openexchange.exception.OXException

Gets the value mapped to given parameter name.

Parameters:

name - The parameter name

Returns:

The value mapped to given parameter name

Throws:

java.lang.NullPointerException - If name is null

com.openexchange.exception.OXException - If no such parameter exists

getParameter

public java.lang.String getParameter(java.lang.String name)

Gets the value mapped to given parameter name.

Parameters:

name - The parameter name

Returns:

The value mapped to given parameter name or null if not present

Throws:

java.lang.NullPointerException - If name is null

optBool

public boolean optBool(java.lang.String name)

Gets optional boolean parameter.

Parameters:

name - The parameter name

Returns:

The boolean

optBool

public boolean optBool(java.lang.String name,
              boolean def)

Gets optional boolean parameter.

Parameters:

name - The parameter name

def - The default value to return if such a parameter is absent

Returns:

The boolean

optInt

public int optInt(java.lang.String name)
           throws com.openexchange.exception.OXException

Gets optional int parameter.

Parameters:

name - The parameter name

Returns:

The int

Throws:

com.openexchange.exception.OXException - If parameter is an invalid number value

checkIntArray

public int[] checkIntArray(java.lang.String name)
                    throws com.openexchange.exception.OXException

Checks for presence of comma-separated int list.

Parameters:

name - The parameter name

Returns:

The int array

Throws:

com.openexchange.exception.OXException - If an error occurs

checkStringArray

public java.lang.String[] checkStringArray(java.lang.String name)
                                    throws com.openexchange.exception.OXException

Checks for presence of comma-separated String list.

Parameters:

name - The parameter name

Returns:

The String array

Throws:

com.openexchange.exception.OXException - If parameter is absdent

optStringArray

public java.lang.String[] optStringArray(java.lang.String name)

Checks for presence of comma-separated String list.

Parameters:

name - The parameter name

Returns:

The String array

getRequest

public com.openexchange.ajax.requesthandler.AJAXRequestData getRequest()

Gets the request.

Returns:

The request

getSession

public com.openexchange.tools.session.ServerSession getSession()

Gets the session.

Returns:

The session