Module org.apache.sis.referencing
Class LocalizationGridException
Object
Throwable
Exception
FactoryException
FactoryDataException
LocalizationGridException
- All Implemented Interfaces:
Serializable
Thrown when a localization grid cannot be computed, presumably because of a problem with grid data.
It may be because some grid coordinates are out of CRS domain of validity, causing either
MathTransform
to be thrown or Double.NaN
coordinate values to be computed.
Additional information on exception cause
It is sometimes difficult to determine the root cause of this exception. For example, grid points slightly outside the CRS domain of validity will not necessarily cause a failure. A strategy can be to try to build the grid anyway, and in case of failure declare that the grid was maybe too far from CRS domain of validity. Because the potential causes are better known by the code that wants a localization grid instead of theLocalizationGridBuilder
class, LocalizationGridException
provides a setPotentialCause(CharSequence)
method for allowing top-level code to attach additional
information to this exception.- Since:
- 1.2
- See Also:
-
Constructor Summary
ConstructorDescriptionConstruct an exception with no detail message.LocalizationGridException
(String message) Constructs an exception with the specified detail message.LocalizationGridException
(String message, Throwable cause) Constructs an exception with the specified detail message and cause.Constructs an exception with the specified cause. -
Method Summary
Modifier and TypeMethodDescriptionReturns the value given to the last call ofsetPotentialCause(CharSequence)
.void
setPotentialCause
(CharSequence details) Specifies additional information about what may be the cause of this exception.Methods inherited from class Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
Constructor Details
-
LocalizationGridException
public LocalizationGridException()Construct an exception with no detail message. -
LocalizationGridException
Constructs an exception with the specified detail message.- Parameters:
message
- the detail message, saved for later retrieval by theThrowable.getMessage()
method.
-
LocalizationGridException
Constructs an exception with the specified cause.- Parameters:
cause
- the cause, saved for later retrieval by theThrowable.getCause()
method.
-
LocalizationGridException
Constructs an exception with the specified detail message and cause. The cause is the exception thrown in the underlying database (e.g.IOException
orSQLException
).- Parameters:
message
- the detail message, saved for later retrieval by theThrowable.getMessage()
method.cause
- the cause, saved for later retrieval by theThrowable.getCause()
method.
-
-
Method Details
-
setPotentialCause
Specifies additional information about what may be the cause of this exception. Example: "The grid spans more than 180° of longitude", which may be a cause of map projection failures.- Parameters:
details
- a potential cause, ornull
if none. The type should beString
orInternationalString
.
-
getPotentialCause
Returns the value given to the last call ofsetPotentialCause(CharSequence)
.- Returns:
- potential cause, or
null
if none. The type should beString
orInternationalString
.
-