org.fuchss.objectcasket.common.CasketException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of object-casket Show documentation

Object Casket is a simple O/R mapper that can be used together with the Java Persistence API (JPA). The aim is to provide a simple solution for small projects to store multi-related entities in a simple manner.

There is a newer version: 0.20.17

Show newest version

package org.fuchss.objectcasket.common;

import java.io.Serial;
import java.util.Arrays;
import java.util.Objects;

import org.fuchss.objectcasket.common.CasketError.CE0;

/**
 * The common Exception class for the object-casket system.
 *
 * @see CasketError
 */
public class CasketException extends Exception {

	@Serial
	private static final long serialVersionUID = 1L;

	/**
	 * The underlying error code.
	 */
	private final transient CasketError error;

	private CasketException(Throwable cause) {
		super(cause);
		this.error = CE0.EXTERNAL_ERROR;
	}

	CasketException(CasketError error, String msg) {
		super(String.format("Object Casket Error: %s%n\tReason: %s)", error.name(), msg));
		this.error = error;
		StackTraceElement[] stack = this.getStackTrace();
		this.setStackTrace(Arrays.copyOfRange(stack, 1, stack.length));
	}

	/**
	 * Converts an arbitrary Exception into an CasketException.
	 *
	 * @param exc
	 *            - the exception to convert.
	 * @return the CasketException.
	 */
	public static CasketException build(Exception exc) {
		Objects.requireNonNull(exc);
		StackTraceElement[] original = exc.getStackTrace();
		exc.setStackTrace(Arrays.copyOfRange(original, 1, original.length));

		if (exc instanceof CasketException aCasketException)
			return aCasketException;
		return new CasketException(exc);
	}

	/**
	 * @return the underlying error code.
	 * @see CasketError
	 */
	public CasketError error() {
		return this.error;
	}

}