org.osgl.mvc.result

Class BadRequest

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.osgl.exception.FastRuntimeException

org.osgl.mvc.result.Result

org.osgl.mvc.result.ErrorResult

org.osgl.mvc.result.BadRequest

All Implemented Interfaces:

Serializable

public class BadRequest
extends ErrorResult

Indicate a client error

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.osgl.mvc.result.Result

Result.Payload

Field Summary

Fields

Modifier and Type	Field and Description
static BadRequest	INSTANCE Deprecated.

Constructor Summary

Constructors

Constructor and Description
BadRequest()
BadRequest(int errorCode)
BadRequest(int errorCode, String message, Object... args)
BadRequest(int errorCode, Throwable cause)
BadRequest(int errorCode, Throwable cause, String message, Object... args)
BadRequest(String message, Object... args)
BadRequest(Throwable cause)
BadRequest(Throwable cause, String message, Object... args)

Method Summary

Modifier and Type	Method and Description
static BadRequest	get() Returns a static BadRequest instance and set the Result.payload thread local with default message.
static BadRequest	of(int errorCode) Returns a static BadRequest instance and set the Result.payload thread local with error code and default message.
static BadRequest	of(int errorCode, String message, Object... args) Returns a static BadRequest instance and set the Result.payload thread local with error code and message specified.
static BadRequest	of(int errorCode, Throwable cause) Returns a static BadRequest instance and set the Result.payload thread local with error code and cause specified.
static BadRequest	of(int errorCode, Throwable cause, String message, Object... args) Returns a static BadRequest instance and set the Result.payload thread local with error code, cause and message specified.
static BadRequest	of(String message, Object... args) Returns a static BadRequest instance and set the Result.payload thread local with message specified.
static BadRequest	of(Throwable cause) Returns a static BadRequest instance and set the Result.payload thread local with cause specified.
static BadRequest	of(Throwable cause, String message, Object... args) Returns a static BadRequest instance and set the Result.payload thread local with cause and message specified.

Methods inherited from class org.osgl.mvc.result.ErrorResult

_localizedErrorMsg, applyMessage, attach, attachment, attachment, defaultMessage, errorCode, errorCode, getLocalizedMessage, of, of, of, of, of, of, of, toJsonString, toKVStore, toString

Methods inherited from class org.osgl.mvc.result.Result

addCookie, addHeader, apply, applyAfterCommitHandler, applyBeforeCommitHandler, applyCookies, applyHeaders, applyStatus, clearThreadLocals, header, payload, status, status, statusCode, timestamp, touchPayload

Methods inherited from class org.osgl.exception.FastRuntimeException

doFillInStackTrace, fillInStackTrace

Methods inherited from class java.lang.Throwable

addSuppressed, getCause, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

INSTANCE

@Deprecated
public static final BadRequest INSTANCE

Deprecated.

The static instance of BadRequest result.

This is deprecated. Please use get() instead

Constructor Detail

BadRequest

public BadRequest()

BadRequest

public BadRequest(String message,
                  Object... args)

BadRequest

public BadRequest(Throwable cause,
                  String message,
                  Object... args)

BadRequest

public BadRequest(Throwable cause)

BadRequest

public BadRequest(int errorCode)

BadRequest

public BadRequest(int errorCode,
                  String message,
                  Object... args)

BadRequest

public BadRequest(int errorCode,
                  Throwable cause,
                  String message,
                  Object... args)

BadRequest

public BadRequest(int errorCode,
                  Throwable cause)

Method Detail

get

public static BadRequest get()

Returns a static BadRequest instance and set the Result.payload thread local with default message.

When calling the instance on Throwable.getMessage() method, it will return whatever stored in the Result.payload thread local

Returns:

a static BadRequest instance as described above

of

public static BadRequest of(String message,
                            Object... args)

Returns a static BadRequest instance and set the Result.payload thread local with message specified.

When calling the instance on Throwable.getMessage() method, it will return whatever stored in the Result.payload thread local

Parameters:

message - the message

args - the message arguments

Returns:

a static BadRequest instance as described above

of

public static BadRequest of(Throwable cause)

Returns a static BadRequest instance and set the Result.payload thread local with cause specified.

When calling the instance on Throwable.getMessage() method, it will return whatever stored in the Result.payload thread local

Parameters:

cause - the cause

Returns:

a static BadRequest instance as described above

of

public static BadRequest of(Throwable cause,
                            String message,
                            Object... args)

Returns a static BadRequest instance and set the Result.payload thread local with cause and message specified.

When calling the instance on Throwable.getMessage() method, it will return whatever stored in the Result.payload thread local

Parameters:

cause - the cause

message - the message

args - the message arguments

Returns:

a static BadRequest instance as described above

of

public static BadRequest of(int errorCode)

Returns a static BadRequest instance and set the Result.payload thread local with error code and default message.

When calling the instance on Throwable.getMessage() method, it will return whatever stored in the Result.payload thread local

Parameters:

errorCode - the app defined error code

Returns:

a static BadRequest instance as described above

of

public static BadRequest of(int errorCode,
                            String message,
                            Object... args)

Returns a static BadRequest instance and set the Result.payload thread local with error code and message specified.

When calling the instance on Throwable.getMessage() method, it will return whatever stored in the Result.payload thread local

Parameters:

errorCode - app defined error code

message - the message

args - the message arguments

Returns:

a static BadRequest instance as described above

of

public static BadRequest of(int errorCode,
                            Throwable cause)

Returns a static BadRequest instance and set the Result.payload thread local with error code and cause specified.

When calling the instance on Throwable.getMessage() method, it will return whatever stored in the Result.payload thread local

Parameters:

cause - the cause

errorCode - app defined error code

Returns:

a static BadRequest instance as described above

of

public static BadRequest of(int errorCode,
                            Throwable cause,
                            String message,
                            Object... args)

Returns a static BadRequest instance and set the Result.payload thread local with error code, cause and message specified.

When calling the instance on Throwable.getMessage() method, it will return whatever stored in the Result.payload thread local

Parameters:

cause - the cause

errorCode - app defined error code

message - the message

args - the message arguments

Returns:

a static BadRequest instance as described above