org.jamplate.model

Class DocumentNotFoundException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

org.jamplate.model.DocumentNotFoundException

All Implemented Interfaces:

java.io.Serializable

public class DocumentNotFoundException
extends java.io.IOException

An exception that indicates that an attempt to read an unreadable document occurred.

Since:

0.2.0 ~2021.05.15

Version:

0.2.0

Author:

LSafer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected @Nullable Document	document The document that was not found.

Constructor Summary

Constructors

Constructor and Description
DocumentNotFoundException() Constructs an DocumentNotFoundException with null as its error detail message.
DocumentNotFoundException(@Nullable Document document) Construct a new DocumentNotFoundException with the given document as the document that was not found.
DocumentNotFoundException(@Nullable java.lang.String message) Constructs an DocumentNotFoundException with the specified detail message.
DocumentNotFoundException(@Nullable java.lang.String message, @Nullable Document document) Construct a new DocumentNotFoundException with the given document as the document that was not found and with the given message.
DocumentNotFoundException(@Nullable java.lang.String message, @Nullable java.lang.Throwable cause) Constructs an DocumentNotFoundException with the specified detail message and cause.
DocumentNotFoundException(@Nullable java.lang.String message, @Nullable java.lang.Throwable cause, @Nullable Document document) Construct a new DocumentNotFoundException with the given document as the document that was not found and with the given message and cause.
DocumentNotFoundException(@Nullable java.lang.Throwable cause) Constructs an DocumentNotFoundException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).
DocumentNotFoundException(@Nullable java.lang.Throwable cause, @Nullable Document document) Construct a new DocumentNotFoundException with the given document as the document that was not found and with the given cause.

Method Summary

Modifier and Type	Method and Description
@Nullable Document	getDocument() Return the document that was about to be read but was not found and caused this exception to be thrown.

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

Field Detail

document

@Nullable
protected @Nullable Document document

The document that was not found.

Since:

0.2.0 ~2021.05.19

Constructor Detail

DocumentNotFoundException

public DocumentNotFoundException()

Constructs an DocumentNotFoundException with null as its error detail message.

Since:

0.2.0 ~2021.05.19

DocumentNotFoundException

public DocumentNotFoundException(@Nullable
                                 @Nullable java.lang.String message)

Constructs an DocumentNotFoundException with the specified detail message.

Parameters:

message - The detail message (which is saved for later retrieval by the Throwable.getMessage() method)

Since:

0.2.0 ~2021.05.19

DocumentNotFoundException

public DocumentNotFoundException(@Nullable
                                 @Nullable java.lang.String message,
                                 @Nullable
                                 @Nullable java.lang.Throwable cause)

Constructs an DocumentNotFoundException with the specified detail message and cause.

Note that the detail message associated with cause is not automatically incorporated into this exception's detail message.

Parameters:

message - The detail message (which is saved for later retrieval by the Throwable.getMessage() method)

cause - The cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

Since:

0.2.0 ~2021.05.19

DocumentNotFoundException

public DocumentNotFoundException(@Nullable
                                 @Nullable java.lang.Throwable cause)

Constructs an DocumentNotFoundException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause). This constructor is useful for IO exceptions that are little more than wrappers for other throwables.

Parameters:

cause - The cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

Since:

0.2.0 ~2021.05.19

DocumentNotFoundException

public DocumentNotFoundException(@Nullable
                                 @Nullable Document document)

Construct a new DocumentNotFoundException with the given document as the document that was not found.

Parameters:

document - the document that was not found.

Since:

0.2.0 ~2021.05.19

DocumentNotFoundException

public DocumentNotFoundException(@Nullable
                                 @Nullable java.lang.String message,
                                 @Nullable
                                 @Nullable Document document)

Construct a new DocumentNotFoundException with the given document as the document that was not found and with the given message.

Parameters:

message - The detail message (which is saved for later retrieval by the Throwable.getMessage() method)

document - the document that was not found.

Since:

0.2.0 ~2021.05.19

DocumentNotFoundException

public DocumentNotFoundException(@Nullable
                                 @Nullable java.lang.String message,
                                 @Nullable
                                 @Nullable java.lang.Throwable cause,
                                 @Nullable
                                 @Nullable Document document)

Construct a new DocumentNotFoundException with the given document as the document that was not found and with the given message and cause.

Parameters:

message - The detail message (which is saved for later retrieval by the Throwable.getMessage() method)

cause - The cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

document - the document that was not found.

Since:

0.2.0 ~2021.05.19

DocumentNotFoundException

public DocumentNotFoundException(@Nullable
                                 @Nullable java.lang.Throwable cause,
                                 @Nullable
                                 @Nullable Document document)

Construct a new DocumentNotFoundException with the given document as the document that was not found and with the given cause.

Parameters:

cause - The cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

document - the document that was not found.

Since:

0.2.0 ~2021.05.19

Method Detail

getDocument

@Nullable
 @Contract(pure=true)
public @Nullable Document getDocument()

Return the document that was about to be read but was not found and caused this exception to be thrown.

Returns:

the document that was not found. Or null if unknown or non-existing.

Since:

0.2.0 ~2021.05.19