com.codelanx.codelanxlib.util.exception

Class Exceptions

java.lang.Object

com.codelanx.codelanxlib.util.exception.Exceptions

public final class Exceptions
extends Object

A utility class for throwing conditional exceptions, similar to Apache's Validate class.

Since:

0.1.0

Version:

0.1.0

Author:

1Rogue

Method Summary

Modifier and Type	Method and Description
static void	illegalPluginAccess(boolean state) Throws an IllegalPluginAccessException if the value of the state parameter is false
static void	illegalPluginAccess(boolean state, String message) Throws an IllegalPluginAccessException if the value of the state parameter is false
static void	illegalState(boolean state) Throws an IllegalStateException if the value of the state parameter is false
static void	illegalState(boolean state, String message) Throws an IllegalStateException if the value of the state parameter is false
static <T extends RuntimeException> void	isTrue(boolean validate, Class<T> ex) Validates a statement is true, and throws a custom RuntimeException as specified by the passed class parameter
static <T extends RuntimeException> void	isTrue(boolean validate, String message, Class<T> ex) Validates a statement is true, and throws a custom RuntimeException as specified by the passed class parameter
static <T extends RuntimeException> void	notNull(Object obj, Class<T> ex) Provides a null check, and throws a custom RuntimeException as specified by the passed class parameter
static <T extends RuntimeException> void	notNull(Object obj, String message, Class<T> ex) Provides a null check, and throws a custom RuntimeException as specified by the passed class parameter
static String	readableStackTrace(Throwable t) Creates a readable stack trace from a passed Throwable.
static void	unsupportedOperation(boolean state) Throws an UnsupportedOperationException if the value of the state parameter is false
static void	unsupportedOperation(boolean state, String message) Throws an UnsupportedOperationException if the value of the state parameter is false

Methods inherited from class java.lang.Object

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

Method Detail

illegalState

public static void illegalState(boolean state,
                                String message)

Throws an IllegalStateException if the value of the state parameter is false

Parameters:

state - The conditional to verify

message - The message to include in an IllegalStateException

Throws:

IllegalStateException - if state is false

Since:

0.1.0

illegalState

public static void illegalState(boolean state)

Throws an IllegalStateException if the value of the state parameter is false

Parameters:

state - The conditional to verify

Throws:

IllegalStateException - if state is false

Since:

0.1.0

illegalPluginAccess

public static void illegalPluginAccess(boolean state,
                                       String message)

Throws an IllegalPluginAccessException if the value of the state parameter is false

Parameters:

state - The conditional to verify

message - The message to include in an IllegalPluginAccessException

Throws:

IllegalPluginAccessException - if state is false

Since:

0.1.0

illegalPluginAccess

public static void illegalPluginAccess(boolean state)

Throws an IllegalPluginAccessException if the value of the state parameter is false

Parameters:

state - The conditional to verify

Throws:

IllegalPluginAccessException - if state is false

Since:

0.1.0

unsupportedOperation

public static void unsupportedOperation(boolean state,
                                        String message)

Throws an UnsupportedOperationException if the value of the state parameter is false

Parameters:

state - The conditional to verify

message - The message to include in an UnsupportedOperationException

Throws:

UnsupportedOperationException - if state is false

Since:

0.1.0

unsupportedOperation

public static void unsupportedOperation(boolean state)

Throws an UnsupportedOperationException if the value of the state parameter is false

Parameters:

state - The conditional to verify

Throws:

UnsupportedOperationException - if state is false

Since:

0.1.0

notNull

public static <T extends RuntimeException> void notNull(Object obj,
                                                        String message,
                                                        Class<T> ex)

Provides a null check, and throws a custom RuntimeException as specified by the passed class parameter

Type Parameters:

T - The exception type

Parameters:

obj - The object to check for null

message - The message to add to the exception if obj is null

ex - The RuntimeException class to instantiate

Since:

0.1.0

notNull

public static <T extends RuntimeException> void notNull(Object obj,
                                                        Class<T> ex)

Provides a null check, and throws a custom RuntimeException as specified by the passed class parameter

Type Parameters:

T - The exception type

Parameters:

obj - The object to check for null

ex - The RuntimeException class to instantiate

Since:

0.1.0

isTrue

public static <T extends RuntimeException> void isTrue(boolean validate,
                                                       String message,
                                                       Class<T> ex)

Validates a statement is true, and throws a custom RuntimeException as specified by the passed class parameter

Type Parameters:

T - The exception type

Parameters:

validate - The boolean to evaluate

message - The message to add to the exception if obj is null

ex - The RuntimeException class to instantiate

Since:

0.1.0

isTrue

public static <T extends RuntimeException> void isTrue(boolean validate,
                                                       Class<T> ex)

Validates a statement is true, and throws a custom RuntimeException as specified by the passed class parameter

Type Parameters:

T - The exception type

Parameters:

validate - The boolean to evaluate

ex - The RuntimeException class to instantiate

Since:

0.1.0

readableStackTrace

public static String readableStackTrace(Throwable t)

Creates a readable stack trace from a passed Throwable. This method will reproduce the same output that Throwable.printStackTrace() would output

Parameters:

t - The Throwable to make readable

Returns:

A string representing the entire stack trace

Since:

0.1.0