Constructor Detail

• JSimpleDBFactory

  public JSimpleDBFactory()

Method Detail

• setModelClasses

  public JSimpleDBFactory setModelClasses(Iterable<? extends Class<?>> modelClasses)

  Configure the Java model classes.

  Note: @JSimpleClass-annotated super-types of any class in modelClasses will be included, even if the super-type is not explicitly specified in modelClasses.

  Parameters:

  modelClasses - classes annotated with @JSimpleClass annotations

  Returns:

  this instance

• setModelClasses

  public JSimpleDBFactory setModelClasses(Class<?>... modelClasses)

  Configure the Java model classes.

  Equivalent to setModelClasses(Arrays.asList(modelClasses)).

  Parameters:

  modelClasses - classes annotated with @JSimpleClass annotations

  Returns:

  this instance

  See Also:

  setModelClasses(Iterable)

• setDatabase

  public JSimpleDBFactory setDatabase(Database database)

  Configure the underlying Database for this instance.

  By default this instance will use an initially empty, in-memory SimpleKVDatabase.

  Parameters:

  database - core API database to use

  Returns:

  this instance

• setSchemaVersion

  public JSimpleDBFactory setSchemaVersion(int schemaVersion)

  Configure the schema version number associated with the configured Java model classes.

  A value of zero means to use whatever is the highest version already recorded in the database. However, if this instance has no Database configured, then an empty SimpleKVDatabase is used and therefore a schema version of 1 is assumed.

  Parameters:

  schemaVersion - the schema version number of the schema derived from the configured Java model classes, or zero to default to the highest version already recorded in the database

  Returns:

  this instance

• setStorageIdGenerator

  public JSimpleDBFactory setStorageIdGenerator(StorageIdGenerator storageIdGenerator)

  Configure the StorageIdGenerator for auto-generating storage ID's when not explicitly specified in @JSimpleClass, @JField, etc., annotations.

  This instance will initially be configured with a DefaultStorageIdGenerator. To disable auto-generation of storage ID's altogether, configure a null value here.

  Parameters:

  storageIdGenerator - storage ID generator, or null to disable auto-generation of storage ID's

  Returns:

  this instance

• setValidatorFactory

  public JSimpleDBFactory setValidatorFactory(ValidatorFactory validatorFactory)

  Configure a custom ValidatorFactory used to create Validators for validation within transactions.

  Parameters:

  validatorFactory - factory for validators

  Returns:

  this instance

  Throws:

  IllegalArgumentException - if validatorFactory is null

• newJSimpleDB

  public JSimpleDB newJSimpleDB()

  Construct a JSimpleDB instance using this instance's configuration.

  Returns:

  newly created JSimpleDB database

  Throws:

  IllegalArgumentException - if this instance has an incomplete or invalid configuration

  IllegalArgumentException - if any Java model class has an invalid annotation