Package ai.docling.serve.api.validation

Class ValidationErrorDetail

java.lang.Object

ai.docling.serve.api.validation.ValidationErrorDetail

public class ValidationErrorDetail
extends Object

Represents detailed information about a validation error. This class provides structured data associated with a validation error, including the locations of the error, an error message, the type of validation error, and the input causing the error.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ValidationErrorDetail.Builder	Builder class for constructing instances of the enclosing class.

Method Summary

Modifier and Type	Method	Description
static @NonNull ValidationErrorDetail.Builder	builder()
@NonNull ValidationErrorContext	getContext()	Represents the context information associated with a validation error.
@Nullable Object	getInput()	Represents the input causing the validation error.
List<Object>	getLocations()	Represents the specific locations associated with a validation error.
@Nullable String	getMessage()	Represents an optional validation error message.
@Nullable String	getType()	Represents the type of validation error.
@NonNull ValidationErrorDetail.Builder	toBuilder()
@NonNull String	toString()

Methods inherited from class java.lang.Object

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

Method Details

builder

public static @NonNull ValidationErrorDetail.Builder builder()

toBuilder

public @NonNull ValidationErrorDetail.Builder toBuilder()

getLocations

public List<Object> getLocations()

Represents the specific locations associated with a validation error.

Returns:

the specific locations associated with a validation error

getMessage

public @Nullable String getMessage()

Represents an optional validation error message.

Returns:

the optional validation error message

getType

public @Nullable String getType()

Represents the type of validation error.

Returns:

the type of validation error

getInput

public @Nullable Object getInput()

Represents the input causing the validation error.

Returns:

the input causing the validation error

getContext

@NonNull
public @NonNull ValidationErrorContext getContext()

Represents the context information associated with a validation error.

Returns:

the context information associated with a validation error

toString

public @NonNull String toString()

Overrides:

toString in class Object