com.inmanlabs.commons.web

Class ApiResponse<T>

java.lang.Object

com.inmanlabs.commons.web.ApiResponse<T>

Type Parameters:

T - The Type of the Entity that will be embedded in the API Response.

Direct Known Subclasses:

ApiListResponse

public class ApiResponse<T>
extends Object

Response wrapper for JSON API.

Constructor Summary

Constructors

Constructor and Description
ApiResponse()

Method Summary

Modifier and Type	Method and Description
static <T> ApiResponse<T>	error(String message, int status)
static <T> ApiResponse<T>	fail(String message)
static <T> ApiResponse<T>	fromOptional(Optional<T> optionalData) Returns the value of the Optional if it exists, otherwise throws a "404 Not Found" exception
T	getData()
ApiError	getError()
ApiResponseStatus	getStatus()
void	setData(T data)
void	setError(ApiError error)
void	setStatus(ApiResponseStatus status)
static <T> ApiResponse<T>	success(T data)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiResponse

public ApiResponse()

Method Detail

getStatus

public ApiResponseStatus getStatus()

setStatus

public void setStatus(ApiResponseStatus status)

getData

public T getData()

setData

public void setData(T data)

getError

public ApiError getError()

setError

public void setError(ApiError error)

fromOptional

public static <T> ApiResponse<T> fromOptional(Optional<T> optionalData)
                                       throws NotFoundException

Returns the value of the Optional if it exists, otherwise throws a "404 Not Found" exception

Type Parameters:

T - The Type of the Optional

Parameters:

optionalData - An Optional who's contents we want to return

Returns:

the contents of the Optional element

Throws:

NotFoundException - if Optional is empty

success

public static <T> ApiResponse<T> success(T data)

error

public static <T> ApiResponse<T> error(String message,
                                       int status)

fail

public static <T> ApiResponse<T> fail(String message)

toString

public String toString()

Overrides:

toString in class Object