apache > db
Apache DB Project
Font size:      

Apache Derby: Documenting messages

Error and warning messages are documented in the Derby Reference Manual. When you add internationalized messages to the Derby engine, add the messages to the xml descriptors file that is located in ..java/engine/org/apache/derby/loc/messages.xml. Specify friendly names for the message arguments. The friendly names appear in the SQLState tables in the Derby Reference Manual. Avoid vacuous names like "value". Useful, friendly names are:

Make sure that you list the friendly argument names in the numeric order that they appear in their messages. For instance, for the following message...

Table {1} in schema {0} cannot be indexed.

...the order of arguments would be...

schemaName tableName

Do not edit the java/engine/org/apache/derby/loc/messages_en.properties file. This file has been removed from code management and is now generated from messages.xml during the Derby build.

The MessageBuilder utility takes the content of the ..java/engine/org/apache/derby/loc/messages.xml file, and updates the topic in the Derby Reference Manual that lists all of the messages. That topic is rrefexcept71493.dita.

Please post feedback to the derby-dev mail list.