org.wildfly.common

Class Assert

java.lang.Object

org.wildfly.common.Assert

public final class Assert
extends Object

A set of assertions and checks.

Author:

David M. Lloyd

Method Summary

Modifier and Type	Method and Description
static <T> T	assertHoldsLock(T monitor) Assert that the given monitor is held by the current thread.
static <T> T	assertNotHoldsLock(T monitor) Assert that the given monitor is not held by the current thread.
static <T> T	assertNotNull(T value) Assert that the value is not null.
static <T> T	checkNotNullParam(String name, T value) Check that the named parameter is not null.
static IllegalStateException	impossibleSwitchCase(int val) Return an exception indicating that the current switch case was intended to be unreachable.
static IllegalStateException	impossibleSwitchCase(long val) Return an exception indicating that the current switch case was intended to be unreachable.
static IllegalStateException	impossibleSwitchCase(Object obj) Return an exception indicating that the current switch case was intended to be unreachable.
static IllegalStateException	unreachableCode() Return an exception indicating that the current code was intended to be unreachable.

Methods inherited from class java.lang.Object

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

Method Detail

checkNotNullParam

@NotNull
public static <T> T checkNotNullParam(String name,
                                               T value)
                                        throws IllegalArgumentException

Check that the named parameter is not null. Use a standard exception message if it is.

Type Parameters:

T - the value type

Parameters:

name - the parameter name

value - the parameter value

Returns:

the value that was passed in

Throws:

IllegalArgumentException - if the value is null

assertNotNull

@NotNull
public static <T> T assertNotNull(T value)

Assert that the value is not null. Use a standard assertion failure message if it is. Only runs if assert is enabled.

Type Parameters:

T - the value type

Parameters:

value - the not-null value

Returns:

the value that was passed in

assertHoldsLock

@NotNull
public static <T> T assertHoldsLock(@NotNull
                                             T monitor)

Assert that the given monitor is held by the current thread. Use a standard assertion failure message if it is not. Only runs if assert is enabled.

Type Parameters:

T - the monitor's type

Parameters:

monitor - the monitor object

Returns:

the value that was passed in

Throws:

IllegalArgumentException - if the monitor is null

assertNotHoldsLock

@NotNull
public static <T> T assertNotHoldsLock(@NotNull
                                                T monitor)

Assert that the given monitor is not held by the current thread. Use a standard assertion failure message if it is. Only runs if assert is enabled.

Type Parameters:

T - the monitor's type

Parameters:

monitor - the monitor object

Returns:

the value that was passed in

Throws:

IllegalArgumentException - if the monitor is null

unreachableCode

public static IllegalStateException unreachableCode()

Return an exception indicating that the current code was intended to be unreachable.

Returns:

the exception which may be immediately thrown

impossibleSwitchCase

@NotNull
public static IllegalStateException impossibleSwitchCase(@NotNull
                                                                  Object obj)

Return an exception indicating that the current switch case was intended to be unreachable.

Parameters:

obj - the switch case value

Returns:

the exception which may be immediately thrown

impossibleSwitchCase

@NotNull
public static IllegalStateException impossibleSwitchCase(int val)

Return an exception indicating that the current switch case was intended to be unreachable.

Parameters:

val - the switch case value

Returns:

the exception which may be immediately thrown

impossibleSwitchCase

@NotNull
public static IllegalStateException impossibleSwitchCase(long val)

Return an exception indicating that the current switch case was intended to be unreachable.

Parameters:

val - the switch case value

Returns:

the exception which may be immediately thrown