net.zer0bandwidth.android.lib.database.sqlitehouse.annotations

Annotation Type SQLiteDatabaseSpec

@Documented
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface SQLiteDatabaseSpec

Annotates a class that defines a SQLite database. This should be applied only to classes that extend SQLiteHouse.

Since:

zer0bandwidth-net/android 0.1.4 (#26)

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	database_name Specifies the name of the database file, as usually supplied to the constructor of SQLiteOpenHelper or SQLitePortal.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.Class<? extends SQLightable>[]	classes A list of classes that constitute the data set being stored in the database.
int	schema_version The current schema version for the database overall, as usually supplied to the constructor of an SQLiteOpenHelper or SQLitePortal.

Element Detail

database_name

public abstract java.lang.String database_name

Specifies the name of the database file, as usually supplied to the constructor of SQLiteOpenHelper or SQLitePortal.

Returns:

the database name

schema_version

public abstract int schema_version

The current schema version for the database overall, as usually supplied to the constructor of an SQLiteOpenHelper or SQLitePortal.

Returns:

the current database schema version

Default:

1

classes

public abstract java.lang.Class<? extends SQLightable>[] classes

A list of classes that constitute the data set being stored in the database. Each of these classes must be decorated with an SQLiteTable annotation and must be capable of containing a row of that table.

Returns:

the list of classes that represent tables of the database

Default:

{}