agi.foundation

(agi.foundation.core-2024r3.jar)

Class ObjectFrozenException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

agi.foundation.ObjectFrozenException

All Implemented Interfaces:

Serializable

public class ObjectFrozenException
extends RuntimeException

An exception that is thrown when an attempt is made to modify an object that has been frozen with a call to IFreezable.freeze().

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ObjectFrozenException() Initializes a new instance.
ObjectFrozenException(Object frozenObject) Initializes a new instance with a reference to the frozen object.
ObjectFrozenException(Object frozenObject, RuntimeException inner) Initializes a new instance with a specified frozen object and a reference to the inner exception that is the cause of this exception.
ObjectFrozenException(String message) Initializes a new instance.
ObjectFrozenException(String message, RuntimeException innerException) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
Object	getFrozenObject() Gets the object that was frozen, if available.

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 Detail

ObjectFrozenException

public ObjectFrozenException()

Initializes a new instance.

ObjectFrozenException

public ObjectFrozenException(String message)

Initializes a new instance.

Parameters:

message - The message associated with the exception.

ObjectFrozenException

public ObjectFrozenException(String message,
                             RuntimeException innerException)

Initializes a new instance.

Parameters:

message - The message associated with the exception.

innerException - The inner exception that caused this exception.

ObjectFrozenException

public ObjectFrozenException(Object frozenObject)

Initializes a new instance with a reference to the frozen object.

Parameters:

frozenObject - The object that is frozen.

ObjectFrozenException

public ObjectFrozenException(Object frozenObject,
                             RuntimeException inner)

Initializes a new instance with a specified frozen object and a reference to the inner exception that is the cause of this exception.

Parameters:

frozenObject - The object that is frozen.

inner - The exception that is the cause of the current exception.

Method Detail

getFrozenObject

@Nullable
public final Object getFrozenObject()

Gets the object that was frozen, if available.