Package io.inversion

Class ApiException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.inversion.ApiException

All Implemented Interfaces:

Status, Serializable

public class ApiException
extends RuntimeException
implements Status

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	status

Fields inherited from interface io.inversion.Status

SC_200_OK, SC_201_CREATED, SC_204_NO_CONTENT, SC_308_PERMANENT_REDIRECT, SC_400_BAD_REQUEST, SC_401_UNAUTHORIZED, SC_403_FORBIDDEN, SC_404_NOT_FOUND, SC_429_TOO_MANY_REQUESTS, SC_500_INTERNAL_SERVER_ERROR, SC_501_NOT_IMPLEMENTED

Constructor Summary

Constructors

Constructor	Description
ApiException()
ApiException(String httpStatus)
ApiException(String messageFormat, Object... args)
ApiException(String httpStatus, Throwable cause, String messageFormat, Object... args)
ApiException(Throwable cause)

Method Summary

Modifier and Type	Method	Description
static String	getMessage(String httpStatus, Throwable cause, String messageFormat, Object... args)	Constructs a useful error message.
String	getStatus()
boolean	hasStatus(int... statusCodes)
static ApiException	new400BadRequest()
static ApiException	new400BadRequest(String messageFormat, Object... messages)
static ApiException	new400BadRequest(Throwable cause)
static ApiException	new400BadRequest(Throwable cause, String messageFormat, Object... messages)
static ApiException	new401Unauthroized()
static ApiException	new401Unauthroized(String messageFormat, Object... messages)
static ApiException	new401Unauthroized(Throwable cause)
static ApiException	new401Unauthroized(Throwable cause, String messageFormat, Object... messages)
static ApiException	new403Forbidden()
static ApiException	new403Forbidden(String messageFormat, Object... messages)
static ApiException	new403Forbidden(Throwable cause)
static ApiException	new403Forbidden(Throwable cause, String messageFormat, Object... messages)
static ApiException	new404NotFound()
static ApiException	new404NotFound(String messageFormat, Object... messages)
static ApiException	new404NotFound(Throwable cause)
static ApiException	new404NotFound(Throwable cause, String messageFormat, Object... messages)
static ApiException	new429TooManyRequests()
static ApiException	new429TooManyRequests(String messageFormat, Object... messages)
static ApiException	new429TooManyRequests(Throwable cause)
static ApiException	new429TooManyRequests(Throwable cause, String messageFormat, Object... messages)
static ApiException	new500InternalServerError()
static ApiException	new500InternalServerError(String messageFormat, Object... args)
static ApiException	new500InternalServerError(Throwable cause)
static ApiException	new500InternalServerError(Throwable cause, String messageFormat, Object... args)
static ApiException	new501NotImplemented()
static ApiException	new501NotImplemented(String messageFormat, Object... args)
static ApiException	new501NotImplemented(Throwable cause)
static ApiException	new501NotImplemented(Throwable cause, String messageFormat, Object... args)
static void	throw400BadRequest()	Deprecated. this pattern was throwing off static code analysis.
static void	throw400BadRequest(String messageFormat, Object... messages)	Deprecated. this pattern was throwing off static code analysis.
static void	throw400BadRequest(Throwable cause)	Deprecated. this pattern was throwing off static code analysis.
static void	throw400BadRequest(Throwable cause, String messageFormat, Object... messages)	Deprecated. this pattern was throwing off static code analysis.
static void	throw401Unauthroized()	Deprecated. this pattern was throwing off static code analysis.
static void	throw401Unauthroized(String messageFormat, Object... messages)	Deprecated. this pattern was throwing off static code analysis.
static void	throw401Unauthroized(Throwable cause)	Deprecated. this pattern was throwing off static code analysis.
static void	throw401Unauthroized(Throwable cause, String messageFormat, Object... messages)	Deprecated. this pattern was throwing off static code analysis.
static void	throw403Forbidden()	Deprecated. this pattern was throwing off static code analysis.
static void	throw403Forbidden(String messageFormat, Object... messages)	Deprecated. this pattern was throwing off static code analysis.
static void	throw403Forbidden(Throwable cause)	Deprecated. this pattern was throwing off static code analysis.
static void	throw403Forbidden(Throwable cause, String messageFormat, Object... messages)	Deprecated. this pattern was throwing off static code analysis.
static void	throw404NotFound()	Deprecated. this pattern was throwing off static code analysis.
static void	throw404NotFound(String messageFormat, Object... messages)	Deprecated. this pattern was throwing off static code analysis.
static void	throw404NotFound(Throwable cause)	Deprecated. this pattern was throwing off static code analysis.
static void	throw404NotFound(Throwable cause, String messageFormat, Object... messages)	Deprecated. this pattern was throwing off static code analysis.
static void	throw429TooManyRequests()	Deprecated. this pattern was throwing off static code analysis.
static void	throw429TooManyRequests(String messageFormat, Object... messages)	Deprecated. this pattern was throwing off static code analysis.
static void	throw429TooManyRequests(Throwable cause)	Deprecated. this pattern was throwing off static code analysis.
static void	throw429TooManyRequests(Throwable cause, String messageFormat, Object... messages)	Deprecated. this pattern was throwing off static code analysis.
static void	throw500InternalServerError()	Deprecated. this pattern was throwing off static code analysis.
static void	throw500InternalServerError(String messageFormat, Object... args)	Deprecated. this pattern was throwing off static code analysis.
static void	throw500InternalServerError(Throwable cause)	Deprecated. this pattern was throwing off static code analysis.
static void	throw500InternalServerError(Throwable cause, String messageFormat, Object... args)	Deprecated. this pattern was throwing off static code analysis.
static void	throw501NotImplemented()	Deprecated. this pattern was throwing off static code analysis.
static void	throw501NotImplemented(String messageFormat, Object... args)	Deprecated. this pattern was throwing off static code analysis.
static void	throw501NotImplemented(Throwable cause)	Deprecated. this pattern was throwing off static code analysis.
static void	throw501NotImplemented(Throwable cause, String messageFormat, Object... args)	Deprecated. this pattern was throwing off static code analysis.
static void	throwEx(String messageFormat, Object... args)	Throws a 500 INTERNAL SERVER ERROR ApiException with the given message
static void	throwEx(String status, Throwable cause, String messageFormat, Object... args)
static void	throwEx(Throwable cause)	Rethrows cause as a 500 INTERNAL SERVER ERROR ApiException
ApiException	withStatus(String status)

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Details

status

protected String status

Constructor Details

ApiException

public ApiException()
             throws ApiException

Throws:

ApiException

ApiException

public ApiException(Throwable cause)
             throws ApiException

Throws:

ApiException

ApiException

public ApiException(String httpStatus)
             throws ApiException

Throws:

ApiException

ApiException

public ApiException(String messageFormat,
 Object... args)
             throws ApiException

Throws:

ApiException

ApiException

public ApiException(String httpStatus,
 Throwable cause,
 String messageFormat,
 Object... args)
             throws ApiException

Throws:

ApiException

Method Details

getMessage

public static String getMessage(String httpStatus,
 Throwable cause,
 String messageFormat,
 Object... args)

Constructs a useful error message.

All arguments are optional but if everything is null you will get an empty string.

Parameters:

httpStatus - the HTTP stats codde of the error

cause - the cause of the error

messageFormat - the caller supplied error message with variable placeholders

args - variables to insert into messageFormat

Returns:

a hopefully user friendly error message

See Also:

• Utils.format(String, Object...)

throwEx

public static void throwEx(Throwable cause)
                    throws ApiException

Rethrows cause as a 500 INTERNAL SERVER ERROR ApiException

Parameters:

cause - the cause of the error

Throws:

ApiException - always

throwEx

public static void throwEx(String messageFormat,
 Object... args)
                    throws ApiException

Throws a 500 INTERNAL SERVER ERROR ApiException with the given message

Parameters:

messageFormat - the error message potentially with variables

args - values substituted into messageFormat

Throws:

ApiException - always

throwEx

public static void throwEx(String status,
 Throwable cause,
 String messageFormat,
 Object... args)
                    throws ApiException

Throws:

ApiException

new400BadRequest

public static ApiException new400BadRequest()
                                     throws ApiException

Throws:

ApiException

new400BadRequest

public static ApiException new400BadRequest(Throwable cause)
                                     throws ApiException

Throws:

ApiException

new400BadRequest

public static ApiException new400BadRequest(String messageFormat,
 Object... messages)
                                     throws ApiException

Throws:

ApiException

new400BadRequest

public static ApiException new400BadRequest(Throwable cause,
 String messageFormat,
 Object... messages)
                                     throws ApiException

Throws:

ApiException

new401Unauthroized

public static ApiException new401Unauthroized()
                                       throws ApiException

Throws:

ApiException

new401Unauthroized

public static ApiException new401Unauthroized(Throwable cause)
                                       throws ApiException

Throws:

ApiException

new401Unauthroized

public static ApiException new401Unauthroized(String messageFormat,
 Object... messages)
                                       throws ApiException

Throws:

ApiException

new401Unauthroized

public static ApiException new401Unauthroized(Throwable cause,
 String messageFormat,
 Object... messages)
                                       throws ApiException

Throws:

ApiException

new403Forbidden

public static ApiException new403Forbidden()
                                    throws ApiException

Throws:

ApiException

new403Forbidden

public static ApiException new403Forbidden(Throwable cause)
                                    throws ApiException

Throws:

ApiException

new403Forbidden

public static ApiException new403Forbidden(String messageFormat,
 Object... messages)
                                    throws ApiException

Throws:

ApiException

new403Forbidden

public static ApiException new403Forbidden(Throwable cause,
 String messageFormat,
 Object... messages)
                                    throws ApiException

Throws:

ApiException

new404NotFound

public static ApiException new404NotFound()
                                   throws ApiException

Throws:

ApiException

new404NotFound

public static ApiException new404NotFound(Throwable cause)
                                   throws ApiException

Throws:

ApiException

new404NotFound

public static ApiException new404NotFound(String messageFormat,
 Object... messages)
                                   throws ApiException

Throws:

ApiException

new404NotFound

public static ApiException new404NotFound(Throwable cause,
 String messageFormat,
 Object... messages)
                                   throws ApiException

Throws:

ApiException

new429TooManyRequests

public static ApiException new429TooManyRequests()
                                          throws ApiException

Throws:

ApiException

new429TooManyRequests

public static ApiException new429TooManyRequests(Throwable cause)
                                          throws ApiException

Throws:

ApiException

new429TooManyRequests

public static ApiException new429TooManyRequests(String messageFormat,
 Object... messages)
                                          throws ApiException

Throws:

ApiException

new429TooManyRequests

public static ApiException new429TooManyRequests(Throwable cause,
 String messageFormat,
 Object... messages)
                                          throws ApiException

Throws:

ApiException

new500InternalServerError

public static ApiException new500InternalServerError()
                                              throws ApiException

Throws:

ApiException

new500InternalServerError

public static ApiException new500InternalServerError(Throwable cause)
                                              throws ApiException

Throws:

ApiException

new500InternalServerError

public static ApiException new500InternalServerError(String messageFormat,
 Object... args)
                                              throws ApiException

Throws:

ApiException

new500InternalServerError

public static ApiException new500InternalServerError(Throwable cause,
 String messageFormat,
 Object... args)
                                              throws ApiException

Throws:

ApiException

new501NotImplemented

public static ApiException new501NotImplemented()
                                         throws ApiException

Throws:

ApiException

new501NotImplemented

public static ApiException new501NotImplemented(Throwable cause)
                                         throws ApiException

Throws:

ApiException

new501NotImplemented

public static ApiException new501NotImplemented(String messageFormat,
 Object... args)
                                         throws ApiException

Throws:

ApiException

new501NotImplemented

public static ApiException new501NotImplemented(Throwable cause,
 String messageFormat,
 Object... args)
                                         throws ApiException

Throws:

ApiException

getStatus

public String getStatus()

withStatus

public ApiException withStatus(String status)

hasStatus

public boolean hasStatus(int... statusCodes)

throw400BadRequest

@Deprecated
public static void throw400BadRequest()
                               throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw400BadRequest

@Deprecated
public static void throw400BadRequest(Throwable cause)
                               throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw400BadRequest

@Deprecated
public static void throw400BadRequest(String messageFormat,
 Object... messages)
                               throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw400BadRequest

@Deprecated
public static void throw400BadRequest(Throwable cause,
 String messageFormat,
 Object... messages)
                               throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw401Unauthroized

@Deprecated
public static void throw401Unauthroized()
                                 throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw401Unauthroized

@Deprecated
public static void throw401Unauthroized(Throwable cause)
                                 throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw401Unauthroized

@Deprecated
public static void throw401Unauthroized(String messageFormat,
 Object... messages)
                                 throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw401Unauthroized

@Deprecated
public static void throw401Unauthroized(Throwable cause,
 String messageFormat,
 Object... messages)
                                 throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw403Forbidden

@Deprecated
public static void throw403Forbidden()
                              throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw403Forbidden

@Deprecated
public static void throw403Forbidden(Throwable cause)
                              throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw403Forbidden

@Deprecated
public static void throw403Forbidden(String messageFormat,
 Object... messages)
                              throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw403Forbidden

@Deprecated
public static void throw403Forbidden(Throwable cause,
 String messageFormat,
 Object... messages)
                              throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw404NotFound

@Deprecated
public static void throw404NotFound()
                             throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw404NotFound

@Deprecated
public static void throw404NotFound(Throwable cause)
                             throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw404NotFound

@Deprecated
public static void throw404NotFound(String messageFormat,
 Object... messages)
                             throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw404NotFound

@Deprecated
public static void throw404NotFound(Throwable cause,
 String messageFormat,
 Object... messages)
                             throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw429TooManyRequests

@Deprecated
public static void throw429TooManyRequests()
                                    throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw429TooManyRequests

@Deprecated
public static void throw429TooManyRequests(Throwable cause)
                                    throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw429TooManyRequests

@Deprecated
public static void throw429TooManyRequests(String messageFormat,
 Object... messages)
                                    throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw429TooManyRequests

@Deprecated
public static void throw429TooManyRequests(Throwable cause,
 String messageFormat,
 Object... messages)
                                    throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw500InternalServerError

@Deprecated
public static void throw500InternalServerError()
                                        throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw500InternalServerError

@Deprecated
public static void throw500InternalServerError(Throwable cause)
                                        throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw500InternalServerError

@Deprecated
public static void throw500InternalServerError(String messageFormat,
 Object... args)
                                        throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw500InternalServerError

@Deprecated
public static void throw500InternalServerError(Throwable cause,
 String messageFormat,
 Object... args)
                                        throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw501NotImplemented

@Deprecated
public static void throw501NotImplemented()
                                   throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw501NotImplemented

@Deprecated
public static void throw501NotImplemented(Throwable cause)
                                   throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw501NotImplemented

@Deprecated
public static void throw501NotImplemented(String messageFormat,
 Object... args)
                                   throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException

throw501NotImplemented

@Deprecated
public static void throw501NotImplemented(Throwable cause,
 String messageFormat,
 Object... args)
                                   throws ApiException

Deprecated.

this pattern was throwing off static code analysis. It is recommended to replace the usage of this method with "throw ApiException.newXXX(...)

Throws:

ApiException