Package org.apache.sis.io.wkt
Class UnparsableObjectException
java.lang.Object
java.lang.Throwable
java.lang.Exception
java.text.ParseException
org.apache.sis.io.wkt.UnparsableObjectException
- All Implemented Interfaces:
Serializable
,LocalizedException
Thrown when a Well Known Text (WKT) cannot be parsed.
Localization
This exception may contain the error message in two languages:getMessage()
returns the message in the default locale. In a client-server architecture, this is typically the locale on the server side.getLocalizedMessage()
returns the message in the locale given in argument to theWKTFormat
constructor. In a client-server architecture, it is presumably the locale on the client side.
- Since:
- 0.8
- Version:
- 0.8
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate short
The resources key as one of theErrors.Keys
constant, or 0 if none.private Object[]
The parameters for the localization message.private static final long
For cross-version compatibility. -
Constructor Summary
ConstructorsConstructorDescriptionUnparsableObjectException
(String message, int errorOffset) Creates an exception with the specified details message.UnparsableObjectException
(Locale locale, short key, Object[] parameters, int errorOffset) Creates an exception with a message formatted from the given resource key and message parameters. -
Method Summary
Modifier and TypeMethodDescriptionorg.opengis.util.InternationalString
If this exception is capable to return the message in various locales, returns that message.Returns a localized version of the exception message, typically for final user.Returns the exception message in the default locale, typically for system administrator.Initializes the cause of this throwable to the specified value.Methods inherited from class java.text.ParseException
getErrorOffset
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDFor cross-version compatibility.- See Also:
-
key
private transient short keyThe resources key as one of theErrors.Keys
constant, or 0 if none.This field is not serialized because key values sometimes change between different SIS versions. The deserialized value will be 0, which will cause this
UnparsableObjectException
to fallback onsuper.getMessage()
. -
parameters
The parameters for the localization message.
-
-
Constructor Details
-
UnparsableObjectException
Creates an exception with the specified details message.- Parameters:
message
- the detail message in the default locale.errorOffset
- the position where the error is found while parsing.
-
UnparsableObjectException
Creates an exception with a message formatted from the given resource key and message parameters.- Parameters:
locale
- the locale forgetLocalizedMessage()
, ornull
for the default.key
- the resource key as one of theErrors.Keys
constant.parameters
- the values to be given toIndexedResourceBundle.getString(short, Object)
.errorOffset
- the position where the error is found while parsing.
-
-
Method Details
-
getMessage
Returns the exception message in the default locale, typically for system administrator.- Specified by:
getMessage
in interfaceLocalizedException
- Overrides:
getMessage
in classThrowable
- Returns:
- the message of this exception.
-
getLocalizedMessage
Returns a localized version of the exception message, typically for final user. This is often the same message than the one returned bygetMessage()
, but may in some occasions be in a different language ifWKTFormat
has been constructed with a different locale.- Specified by:
getLocalizedMessage
in interfaceLocalizedException
- Overrides:
getLocalizedMessage
in classThrowable
- Returns:
- the localized message of this exception.
-
getInternationalMessage
public org.opengis.util.InternationalString getInternationalMessage()If this exception is capable to return the message in various locales, returns that message. Otherwise returnsnull
.- Specified by:
getInternationalMessage
in interfaceLocalizedException
- Returns:
- the exception message, or
null
if this exception cannot produce international message.
-
initCause
Initializes the cause of this throwable to the specified value.- Overrides:
initCause
in classThrowable
- Parameters:
cause
- the cause saved for later retrieval by theThrowable.getCause()
method.- Returns:
- a reference to this
UnparsableObjectException
instance.
-