Java Error Reporting
This project contains a Java-Builder for Exasol error messages. The invocations of the Builder can be parsed by the error-code-crawler-maven-plugin.
Usage
Simple Messages
ExaError.messageBuilder("E-TEST-1").message("Something went wrong.").toString();Result: E-TEST-1: Something went wrong.
Parameters
You can specify placeholders in the message and replace them with parameters values, as follows:
ExaError.messageBuilder("E-TEST-2")
.message("Unknown input: {{input}}.")
.parameter("input", "unknown", "The illegal user input.").toString();Result:
E-TEST-2: Unknown input: 'unknown'.`
The optional third parameter for parameter(placeholder, value, description) is used by the error-code-crawler-maven-plugin to generate a parameter description.
The builder automatically quotes parameters (depending on the type of the parameter).
If you don't want that, use the uq switch in the correspondent placeholder. Switches are separated with a pipe symbol "|" from the parameter name.
ExaError.messageBuilder("E-TEST-2")
.message("Unknown input: {{input|uq}}.")
.parameter("input", "unknown", "The illegal user input.").toString();Result:
E-TEST-2: Unknown input: unknown.
From version 0.3.0 on you can achieve the same result by specifying the parameter values directly in the message() method. This is a convenience variant that is a little bit more compact, but lacks the chance to describe the parameter.
ExaError.messageBuilder("E-TEST-2")
.message("Message with {{quotedParameter}} and {{unquotedParameter|uq}}.", "q-value", "uq-value").toString();Result:
E-TEST-2: Message with 'q-value' and uq-value.
Mitigations
The mitigations describe actions the user can take to resolve the error. Here is an example of a mitigation definition:
ExaError.messageBuilder("E-TEST-2")
.message("Not enough space on device.")
.mitigation("Delete something.")
.toString();Result:
E-TEST-2: Not enough space on device. Delete something.
You can use parameters in mitigations too.
ExaError.messageBuilder("E-TEST-2")
.message("Not enough space on device {{device}}.")
.mitigation("Delete something from {{device}}.")
.parameter("device", "/dev/sda1", "name of the device")
.toString();Result:
E-TEST-2: Not enough space on device '/dev/sda1'. Delete something from '/dev/sda1'.`
You can chain mitigation definitions if you want to tell the users that there is more than one solution.
ExaError.messageBuilder("E-TEST-2")
.message("Not enough space on device.")
.mitigation("Delete something.")
.mitigation("Create larger partition.")
.toString();Result:
E-TEST-2: Not enough space on device. Known mitigations:
* Delete something.
* Create larger partition.
