@Mojo(name="verify",
      defaultPhase=PROCESS_CLASSES,
      requiresDependencyResolution=COMPILE_PLUS_RUNTIME,
      threadSafe=true)
public class VerifySchemaMojo
extends AbstractMainSchemaMojo

Verify the JSimpleDB schema auto-generated from user-supplied model classes.

This goal verifies that the JSimpleDB schema can be successfully auto-generated from user-supplied model classes. It also checks that the schema will not lead to any SchemaMismatchExceptions at runtime.

Such exceptions occur when either:

• There is already a schema recorded in the database under the configured schema version, but the current schema version is not compatible with it; or
• The current schema version conflicts with one or more other schema versions recorded in the database, e.g., because a field has changed its type.

The first case is detected by having an expected schema XML file. This file corresponds to the project's currently configured JSimpleDB schema version number (which is used to configure JSimpleDB at runtime). It is used to verify that the schema auto-generated from the project's current model classes has not changed in an incompatible way, which would cause an error at runtime. In other words, the actual schema generated from the compiled classes is verified to match what is expected, which is recorded in this file. The current expected schema XML file location is configured by <expectedSchemaFile>;

The second case it detected by supplying XML files containing any old schema versions that are still active in the old schema files directory. All files ending in .xml found anywhere under this directory are checked for incompatibilities with the current schema version. The old schema XML files directory is configured by <oldSchemasDirectory>.

If this goal fails due to an incompatibility of the first type:

• The old expected schema XML file should be moved into the old schemas directory;
• the new expected schema XML file (found in the location configured by <actualSchemaFile>) should be copied to the current expected schema XML file;
• The project's configured JSimpleDB schema version number should be incremented.

If this goal fails due to an incompatibility of the second type, you must adjust your model classes to make them compatible again. For example, manually reassign the conflicting field a different name() or storageId() using the JField annotation.