public abstract class ExceptionDescription extends Object
Most exceptions produced in a layer, has common information (layer name, driver name, error description, error code).
An ExceptionDescription
can provide this extra information describing the cause of the
error, and more useful information to give to the user that works with a layer.
Constructor and Description |
---|
ExceptionDescription()
Sets the name of the layer (if a layer was using) with that this exception was produced.
|
ExceptionDescription(int errorCode,
String errorDescription)
Creates a new
ExceptionDescription with the useful values initialized. |
Modifier and Type | Method and Description |
---|---|
String |
getDriverName()
Gets the name of the driver (if a driver was using) which this exception was produced.
|
int |
getErrorCode()
Gets the code which identifies the kind of error which is the cause of this exception.
|
String |
getErrorDescription()
Gets the description about the error which produced this exception.
|
abstract String |
getHtmlErrorMessage()
Returns a message that describes the error which produced this exception, formatted in HTML code.
|
String |
getLayerName()
Gets the name of the layer (if a layer was using) with that this exception was produced.
|
void |
setCode(int errorCode)
Sets the code which identifies the kind of error which is the cause of this exception.
|
void |
setDescription(String description)
Sets the description about the error which produced this exception.
|
void |
setDriverName(String driverName)
Sets the name of the driver (if a driver was using) which this exception was produced.
|
void |
setLayerName(String layerName)
Sets the name of the layer (if a layer was using) with that this exception was produced.
|
public ExceptionDescription()
Sets the name of the layer (if a layer was using) with that this exception was produced.
layerName
- the name of the layer (if a layer was using) with that this exception was producedpublic ExceptionDescription(int errorCode, String errorDescription)
Creates a new ExceptionDescription
with the useful values initialized.
errorCode
- code which identifies the kind of error which is the cause of this exceptionerrorDescription
- description about the error which produced this exceptionpublic String getDriverName()
Gets the name of the driver (if a driver was using) which this exception was produced.
public void setDriverName(String driverName)
Sets the name of the driver (if a driver was using) which this exception was produced.
driverName
- the name of the driver (if a driver was using) which this exception was producedpublic String getLayerName()
Gets the name of the layer (if a layer was using) with that this exception was produced.
public void setLayerName(String layerName)
Sets the name of the layer (if a layer was using) with that this exception was produced.
layerName
- the name of the layer (if a layer was using) with that this exception was producedpublic void setCode(int errorCode)
Sets the code which identifies the kind of error which is the cause of this exception.
errorCode
- code which identifies the kind of error which is the cause of this exceptionpublic void setDescription(String description)
Sets the description about the error which produced this exception.
description
- description about the error which produced this exceptionpublic int getErrorCode()
Gets the code which identifies the kind of error which is the cause of this exception.
public String getErrorDescription()
Gets the description about the error which produced this exception.
public abstract String getHtmlErrorMessage()
Returns a message that describes the error which produced this exception, formatted in HTML code.