org.jamplate.model

Class TreeOutOfBoundsException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalArgumentException

org.jamplate.model.IllegalTreeException

org.jamplate.model.TreeOutOfBoundsException

All Implemented Interfaces:

java.io.Serializable

public class TreeOutOfBoundsException
extends IllegalTreeException

An exception to indicate that a provided tree is out of the expected bounds. Usually, this exception is raised when a tree is about to be put into a place where that tree's reference is not contained on.

Since:

0.2.0 ~2021.05.14

Version:

0.2.0

Author:

LSafer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected @Nullable Tree	bounds The tree that defines the bounds.

Fields inherited from class org.jamplate.model.IllegalTreeException

illegal, primary

Constructor Summary

Constructors

Constructor and Description
TreeOutOfBoundsException() Constructs a new exception with null as its detail message.
TreeOutOfBoundsException(@Nullable java.lang.String message) Constructs a new exception with the specified detail message.
TreeOutOfBoundsException(@Nullable java.lang.String message, @Nullable java.lang.Throwable cause) Constructs a new exception with the specified detail message and cause.
TreeOutOfBoundsException(@Nullable java.lang.String message, @Nullable java.lang.Throwable cause, @Nullable Tree bounds, @Nullable Tree illegal) Construct a new tree out of bounds exception with the given bounds and illegal trees.
TreeOutOfBoundsException(@Nullable java.lang.String message, @Nullable Tree bounds, @Nullable Tree illegal) Construct a new tree out of bounds exception with the given bounds and illegal trees.
TreeOutOfBoundsException(@Nullable java.lang.Throwable cause) Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).
TreeOutOfBoundsException(@Nullable java.lang.Throwable cause, @Nullable Tree bounds, @Nullable Tree illegal) Construct a new tree out of bounds exception with the given bounds and illegal trees.
TreeOutOfBoundsException(@Nullable Tree bounds, @Nullable Tree illegal) Construct a new tree out of bounds exception with the given bounds and illegal trees.

Method Summary

Modifier and Type	Method and Description
@Nullable Tree	getBoundsTree() Return the tree that defines the bounds.

Methods inherited from class org.jamplate.model.IllegalTreeException

getIllegalTree, getPrimaryTree

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

bounds

@Nullable
protected @Nullable Tree bounds

The tree that defines the bounds.

Since:

0.2.0 ~2021.05.15

Constructor Detail

TreeOutOfBoundsException

public TreeOutOfBoundsException()

Constructs a new exception with null as its detail message. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

Since:

0.2.0 ~2021.05.14

TreeOutOfBoundsException

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

Constructs a new exception with the specified detail message. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

Parameters:

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

Since:

0.2.0 ~2021.05.14

TreeOutOfBoundsException

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

Constructs a new exception with the specified detail message and cause.

Note that the detail message associated with cause is not automatically incorporated in 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.14

TreeOutOfBoundsException

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

Constructs a new exception 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 exceptions that are little more than wrappers for other throwables (for example, PrivilegedActionException).

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.14

TreeOutOfBoundsException

public TreeOutOfBoundsException(@Nullable
                                @Nullable Tree bounds,
                                @Nullable
                                @Nullable Tree illegal)

Construct a new tree out of bounds exception with the given bounds and illegal trees.

Parameters:

bounds - the tree that defines the bounds.

illegal - the illegal tree.

Since:

0.2.0 ~2021.05.15

TreeOutOfBoundsException

public TreeOutOfBoundsException(@Nullable
                                @Nullable java.lang.String message,
                                @Nullable
                                @Nullable Tree bounds,
                                @Nullable
                                @Nullable Tree illegal)

Construct a new tree out of bounds exception with the given bounds and illegal trees.

Parameters:

message - the message.

bounds - the tree that defines the bounds.

illegal - the illegal tree.

Since:

0.2.0 ~2021.05.15

TreeOutOfBoundsException

public TreeOutOfBoundsException(@Nullable
                                @Nullable java.lang.String message,
                                @Nullable
                                @Nullable java.lang.Throwable cause,
                                @Nullable
                                @Nullable Tree bounds,
                                @Nullable
                                @Nullable Tree illegal)

Construct a new tree out of bounds exception with the given bounds and illegal trees.

Parameters:

message - the message.

cause - the throwable that caused to the construction of this exception.

bounds - the tree that defines the bounds.

illegal - the illegal tree.

Since:

0.2.0 ~2021.05.15

TreeOutOfBoundsException

public TreeOutOfBoundsException(@Nullable
                                @Nullable java.lang.Throwable cause,
                                @Nullable
                                @Nullable Tree bounds,
                                @Nullable
                                @Nullable Tree illegal)

Construct a new tree out of bounds exception with the given bounds and illegal trees.

Parameters:

cause - the throwable that caused to the construction of this exception.

bounds - the tree that defines the bounds.

illegal - the illegal tree.

Since:

0.2.0 ~2021.05.15

Method Detail

getBoundsTree

@Nullable
 @Contract(pure=true)
public @Nullable Tree getBoundsTree()

Return the tree that defines the bounds.

Returns:

the bounds tree. Or null if unknown or non-existing.

Since:

0.2.0 ~2021.05.15