org.fujion.ancillary

Class ComponentException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apache.commons.lang.exception.NestableRuntimeException

org.apache.commons.lang.UnhandledException

org.fujion.ancillary.ComponentException

All Implemented Interfaces:

Serializable, org.apache.commons.lang.exception.Nestable

public class ComponentException
extends org.apache.commons.lang.UnhandledException

Run time exception related to a component operation.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.commons.lang.exception.NestableRuntimeException

delegate

Constructor Summary

Constructors

Constructor and Description
ComponentException(BaseComponent component, String message, Object... args)
ComponentException(Class<? extends BaseComponent> componentClass, String message, Object... args)
ComponentException(String message, Object... args)
ComponentException(Throwable cause, BaseComponent component, String message, Object... args)
ComponentException(Throwable cause, Class<? extends BaseComponent> componentClass, String message, Object... args)
ComponentException(Throwable cause, String message, Object... args)

Method Summary

Modifier and Type	Method and Description
static void	assertTrue(boolean condition, BaseComponent component, String message, Object... args) Asserts that a condition is true, throwing a ComponentException if it is not.
static void	assertTrue(boolean condition, BaseComponent component, Supplier<String> message) Asserts that a condition is true, throwing a ComponentException if it is not.
static void	assertTrue(boolean condition, Class<? extends BaseComponent> componentClass, String message, Object... args) Asserts that a condition is true, throwing a ComponentException if it is not.
static void	assertTrue(boolean condition, Class<? extends BaseComponent> componentClass, Supplier<String> message) Asserts that a condition is true, throwing a ComponentException if it is not.
static void	assertTrue(boolean condition, String message, Object... args) Asserts that a condition is true, throwing a ComponentException if it is not.
static void	assertTrue(boolean condition, Supplier<String> message) Asserts that a condition is true, throwing a ComponentException if it is not.
BaseComponent	getComponent() Returns the component instance that caused the exception.
Class<? extends BaseComponent>	getComponentClass() Returns the class of the component that caused the exception.
String	getMessage() Override default behavior and simply prepend this exception's message to that of its superclass.

Methods inherited from class org.apache.commons.lang.exception.NestableRuntimeException

getCause, getMessage, getMessages, getThrowable, getThrowableCount, getThrowables, indexOfThrowable, indexOfThrowable, printPartialStackTrace, printStackTrace, printStackTrace, printStackTrace

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getLocalizedMessage, getStackTrace, getSuppressed, initCause, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentException

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

ComponentException

public ComponentException(Throwable cause,
                          Class<? extends BaseComponent> componentClass,
                          String message,
                          Object... args)

ComponentException

public ComponentException(Throwable cause,
                          BaseComponent component,
                          String message,
                          Object... args)

ComponentException

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

ComponentException

public ComponentException(Class<? extends BaseComponent> componentClass,
                          String message,
                          Object... args)

ComponentException

public ComponentException(BaseComponent component,
                          String message,
                          Object... args)

Method Detail

assertTrue

public static void assertTrue(boolean condition,
                              Supplier<String> message)

Asserts that a condition is true, throwing a ComponentException if it is not.

Parameters:

condition - Condition to test.

message - The exception message.

Throws:

ComponentException - Thrown if the condition is not met.

assertTrue

public static void assertTrue(boolean condition,
                              Class<? extends BaseComponent> componentClass,
                              Supplier<String> message)

Asserts that a condition is true, throwing a ComponentException if it is not.

Parameters:

condition - Condition to test.

componentClass - Class of the component that caused the exception. May be null.

message - The exception message.

Throws:

ComponentException - Thrown if the condition is not met.

assertTrue

public static void assertTrue(boolean condition,
                              BaseComponent component,
                              Supplier<String> message)

Asserts that a condition is true, throwing a ComponentException if it is not.

Parameters:

condition - Condition to test.

component - Component instance that caused the exception. May be null.

message - The exception message.

Throws:

ComponentException - Thrown if the condition is not met.

assertTrue

public static void assertTrue(boolean condition,
                              String message,
                              Object... args)

Asserts that a condition is true, throwing a ComponentException if it is not.

Parameters:

condition - Condition to test.

message - The exception message.

args - Optional message parameters

Throws:

ComponentException - Thrown if the condition is not met.

assertTrue

public static void assertTrue(boolean condition,
                              Class<? extends BaseComponent> componentClass,
                              String message,
                              Object... args)

Asserts that a condition is true, throwing a ComponentException if it is not.

Parameters:

condition - Condition to test.

componentClass - Class of the component that caused the exception. May be null.

message - The exception message.

args - Optional message parameters

Throws:

ComponentException - Thrown if the condition is not met.

assertTrue

public static void assertTrue(boolean condition,
                              BaseComponent component,
                              String message,
                              Object... args)

Asserts that a condition is true, throwing a ComponentException if it is not.

Parameters:

condition - Condition to test.

component - Component instance that caused the exception. May be null.

message - The exception message.

args - Optional message parameters

Throws:

ComponentException - Thrown if the condition is not met.

getComponent

public BaseComponent getComponent()

Returns the component instance that caused the exception.

Returns:

Component instance that caused the exception. May be null.

getComponentClass

public Class<? extends BaseComponent> getComponentClass()

Returns the class of the component that caused the exception. If a component instance is associated with the exception, the class will be that of the component instance. However, if the exception occurred while attempting to create an instance of a component, the component instance will be null and only the component class will be set.

Returns:

Class of the component that caused the exception. May be null.

getMessage

public String getMessage()

Override default behavior and simply prepend this exception's message to that of its superclass.

Specified by:

getMessage in interface org.apache.commons.lang.exception.Nestable

Overrides:

getMessage in class org.apache.commons.lang.exception.NestableRuntimeException