org.osgl.mvc.result

Class Gone

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

All Implemented Interfaces:

Serializable

public class Gone
extends ErrorResult

Indicates that the resource requested is no longer available and will not be available again. This should be used when a resource has been intentionally removed and the resource should be purged. Upon receiving a 410 status code, the client should not request the resource in the future. Clients such as search engines should remove the resource from their indices. Most use cases do not require clients and search engines to purge the resource, and a “404 Not Found” may be used instead.

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
Gone()
Gone(int errorCode)
Gone(int errorCode, String message, Object... args)
Gone(int errorCode, Throwable cause)
Gone(int errorCode, Throwable cause, String message, Object... args)
Gone(String message, Object... args)
Gone(Throwable cause)
Gone(Throwable cause, String message, Object... args)

Method Summary

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

Gone

public Gone()

Gone

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

Gone

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

Gone

public Gone(Throwable cause)

Gone

public Gone(int errorCode)

Gone

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

Gone

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

Gone

public Gone(int errorCode,
            Throwable cause)

Method Detail

get

public static Gone get()

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

of

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

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

of

public static Gone of(Throwable cause)

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

of

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

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

of

public static Gone of(int errorCode)

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

of

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

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

of

public static Gone of(int errorCode,
                      Throwable cause)

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

of

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

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