org.osgl.mvc.result

Class PaymentRequired

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.PaymentRequired

All Implemented Interfaces:

Serializable

public class PaymentRequired
extends ErrorResult

Reserved for future use. The original intention was that this code might be used as part of some form of digital cash or micropayment scheme, as proposed for example by GNU Taler, but that has not yet happened, and this code is not usually used. Google Developers API uses this status if a particular developer has exceeded the daily limit on requests.

See Also:

Serialized Form

Nested Class Summary

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

Result.Payload

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static PaymentRequired	get() Returns a static PaymentRequired instance and set the Result.payload thread local with default message.
static PaymentRequired	of(int errorCode) Returns a static PaymentRequired instance and set the Result.payload thread local with error code and default message.
static PaymentRequired	of(int errorCode, String message, Object... args) Returns a static PaymentRequired instance and set the Result.payload thread local with error code and message specified.
static PaymentRequired	of(int errorCode, Throwable cause) Returns a static PaymentRequired instance and set the Result.payload thread local with error code and cause specified
static PaymentRequired	of(int errorCode, Throwable cause, String message, Object... args) Returns a static PaymentRequired instance and set the Result.payload thread local with error code, cause and message specified.
static PaymentRequired	of(String message, Object... args) Returns a static PaymentRequired instance and set the Result.payload thread local with message specified.
static PaymentRequired	of(Throwable cause) Returns a static PaymentRequired instance and set the Result.payload thread local with cause specified.
static PaymentRequired	of(Throwable cause, String message, Object... args) Returns a static PaymentRequired 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

Constructor Detail

PaymentRequired

public PaymentRequired()

PaymentRequired

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

PaymentRequired

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

PaymentRequired

public PaymentRequired(Throwable cause)

PaymentRequired

public PaymentRequired(int errorCode)

PaymentRequired

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

PaymentRequired

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

PaymentRequired

public PaymentRequired(int errorCode,
                       Throwable cause)

Method Detail

get

public static PaymentRequired get()

Returns a static PaymentRequired 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 PaymentRequired instance as described above

of

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

Returns a static PaymentRequired 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 PaymentRequired instance as described above

of

public static PaymentRequired of(Throwable cause)

Returns a static PaymentRequired 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 PaymentRequired instance as described above

of

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

Returns a static PaymentRequired 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 PaymentRequired instance as described above

of

public static PaymentRequired of(int errorCode)

Returns a static PaymentRequired 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 PaymentRequired instance as described above

of

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

Returns a static PaymentRequired 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 - the app defined error code

message - the message

args - the message arguments

Returns:

a static PaymentRequired instance as described above

of

public static PaymentRequired of(int errorCode,
                                 Throwable cause)

Returns a static PaymentRequired 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 - the app defined error code

Returns:

a static PaymentRequired instance as described above

of

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

Returns a static PaymentRequired 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 - the app defined error code

message - the message

args - the message arguments

Returns:

a static PaymentRequired instance as described above