Package org.apache.sis.util
Class CorruptedObjectException
Object
Throwable
Exception
RuntimeException
CorruptedObjectException
- All Implemented Interfaces:
- Serializable
May be thrown on attempt to use an object which has been corrupted by a previous operation.
 Apache SIS throws this exception only on a best effort basis, when it detected an
 object in an inconsistent state after the original problem.
 
Analogy:
 this exception has a similar goal than 
 Some use cases for this exception are:
 ConcurrentModificationException: to reduce the risk of
 non-deterministic behavior at an undetermined time in the future after an event has compromised the data integrity.
 Like ConcurrentModificationException, this CorruptedObjectException should be used only to detect
 bugs; it would be wrong to write a program that depends on this exception for its correctness.
 This exception is different than AssertionError in that CorruptedObjectException is not
 necessarily caused by a bug in the library. An object may become corrupted because of external factors, as
 illustrated in the use cases below.
- Attempt to use an aborted calculation:
 if an operation failed in the middle of a structural modification, some specific exception (not thisCorruptedObjectException) should be thrown and the object discarded. But if the user does not discard the object and try to use it again, unpredictable behavior may happen. Some implementations are robust enough for detecting such unsafe usage: their methods may throw thisCorruptedObjectExceptionon attempt to use the object after the original failure.
- Change in an “immutable” object:
 some objects are expected to be immutable. For example, the same Coordinate Reference System (CRS) instance is typically shared by thousands of objects. However,CoordinateReferenceSystemis an interface, Therefore, nothing prevent users from providing a mutable instance. For example if the value returned byCoordinateSystem.getDimension()changes between two invocations, many objects that use that coordinate system will fall in an inconsistent state. If an operation detects such inconsistency, it may throw thisCorruptedObjectException.
Exception cause
Since this exception may be thrown an undetermined amount of time after the data corruption, the root cause is often unknown at this point. Sometimes a more descriptive exception has been thrown earlier, but may have been ignored by the user.- Since:
- 0.5
- See Also:
Defined in the sis-utility module
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs a new exception with no message.Constructs a new exception with the specified cause.CorruptedObjectException(String message) Constructs a new exception with the specified detail message.Constructs a new exception with the name of the given object.
- 
Method SummaryMethods inherited from class ThrowableaddSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
- 
Constructor Details- 
CorruptedObjectExceptionpublic CorruptedObjectException()Constructs a new exception with no message.
- 
CorruptedObjectExceptionConstructs a new exception with the specified detail message.- Parameters:
- message- the detail message, or- nullif none.
 
- 
CorruptedObjectExceptionConstructs a new exception with the specified cause.- Parameters:
- cause- the cause, or- nullif none.
- Since:
- 1.0
 
- 
CorruptedObjectExceptionConstructs a new exception with the name of the given object.- Parameters:
- object- the corrupted object, or- nullif unknown.
- Since:
- 0.6
 
 
-