Package io.deephaven.engine.util.input

Class InputTableValidationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

io.deephaven.UncheckedDeephavenException

io.deephaven.engine.util.input.InputTableValidationException

All Implemented Interfaces:

Serializable

public class InputTableValidationException
extends UncheckedDeephavenException

Thrown when an InputTableUpdater detects an invalid modification.

If an InputTableUpdater detects an invalid modification, by throwing this Exception a detailed error message can be passed back to the gRPC client that initiated the operation. Using a list of structured errors, the client can indicate to the user which of the cells (if known) were invalid.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InputTableValidationException.StructuredError	An error indicating that invalid data was entered; with an optional row position and column name.

Constructor Summary

Constructors

Constructor	Description
InputTableValidationException(String message)	Create an InputTableValidationException with the given message.
InputTableValidationException(String message, List<InputTableValidationException.StructuredError> errors)	Create an InputTableValidationException with the given message.
InputTableValidationException(List<InputTableValidationException.StructuredError> errors)	Create an InputTableValidationException with the given errors.

Method Summary

Modifier and Type	Method	Description
Collection<InputTableValidationException.StructuredError>	getErrors()

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

Constructor Details

InputTableValidationException

public InputTableValidationException(String message)

Create an InputTableValidationException with the given message.

No structured errors are supplied.

Parameters:

message - the error message

InputTableValidationException

public InputTableValidationException(String message,
 List<InputTableValidationException.StructuredError> errors)

Create an InputTableValidationException with the given message.

Parameters:

message - the error message

errors - the structured errors for reporting to callers

InputTableValidationException

public InputTableValidationException(List<InputTableValidationException.StructuredError> errors)

Create an InputTableValidationException with the given errors.

The exception message is generated from the list of errors, attempting to provide a user-actionable summary for callers that do not interpret structured errors.

Parameters:

errors - the structured errors for reporting to callers

Method Details

getErrors

public Collection<InputTableValidationException.StructuredError> getErrors()