A B C D E F G H I L M N O P Q R S T U V W Y

A

ascending() - Method in class nl.qbusict.cupboard.convert.IndexBuilder.CompositeIndexBuilder

Set the index to be in ascending order

B

beginTransaction() - Method in interface nl.qbusict.cupboard.CupboardDatabase

build() - Method in class nl.qbusict.cupboard.convert.IndexBuilder

Build the index

build() - Method in class nl.qbusict.cupboard.convert.IndexBuilder.CompositeIndexBuilder

Build the index

build() - Method in class nl.qbusict.cupboard.CupboardBuilder

Create the Cupboard instance.

byId(long) - Method in class nl.qbusict.cupboard.DatabaseCompartment.QueryBuilder

Perform a query by id.

C

close() - Method in class nl.qbusict.cupboard.QueryResultIterable

Column - Annotation Type in nl.qbusict.cupboard.annotation

Annotation interface that allows one to decouple a field name from a column name, by specifying the column name in an Annotation.

Column(String, EntityConverter.ColumnType) - Constructor for class nl.qbusict.cupboard.convert.EntityConverter.Column

Define an unindexed column

Column(String, EntityConverter.ColumnType, Index) - Constructor for class nl.qbusict.cupboard.convert.EntityConverter.Column

Define a column with an optional index definition

CompositeIndex - Annotation Type in nl.qbusict.cupboard.annotation

Annotation interface that allows one to order columns for a composite index (if another column in the same table shares the same index name in Index) For more information see Why order matters?

Note that annotations are not processed by default.

create(Cupboard, Class<T>) - Method in interface nl.qbusict.cupboard.convert.EntityConverterFactory

Create a converter for the requested type

create(Cupboard, Type) - Method in interface nl.qbusict.cupboard.convert.FieldConverterFactory

Create a new FieldConverter for the given type

createTables() - Method in class nl.qbusict.cupboard.DatabaseCompartment

Create tables for the classes registered with Cupboard.register(Class).

Cupboard - Class in nl.qbusict.cupboard

The entry point of Cupboard is this class.

Cupboard() - Constructor for class nl.qbusict.cupboard.Cupboard

cupboard() - Static method in class nl.qbusict.cupboard.CupboardFactory

CupboardBuilder - Class in nl.qbusict.cupboard

Aids in creating specialized Cupboard instances

CupboardBuilder() - Constructor for class nl.qbusict.cupboard.CupboardBuilder

CupboardBuilder(Cupboard) - Constructor for class nl.qbusict.cupboard.CupboardBuilder

Create a builder based on an existing Cupboard instance.

CupboardDatabase - Interface in nl.qbusict.cupboard

This interface closely mimics the SQLiteDatabase interface, to allow alternative implementations of SQLite to be used with Cupboard.

CupboardFactory - Class in nl.qbusict.cupboard

Factory that provides the global Cupboard instance

CupboardFactory() - Constructor for class nl.qbusict.cupboard.CupboardFactory

CursorCompartment - Class in nl.qbusict.cupboard

CursorCompartment is used to get or iterate results from a Cursor.

CursorCompartment(Cupboard, Cursor) - Constructor for class nl.qbusict.cupboard.CursorCompartment

D

DatabaseCompartment - Class in nl.qbusict.cupboard

Operate on a CupboardDatabase.

DatabaseCompartment(Cupboard, SQLiteDatabase) - Constructor for class nl.qbusict.cupboard.DatabaseCompartment

DatabaseCompartment.QueryBuilder<T> - Class in nl.qbusict.cupboard

DEFAULT_ASCENDING - Static variable in annotation type nl.qbusict.cupboard.annotation.CompositeIndex

DEFAULT_INDEX_NAME - Static variable in annotation type nl.qbusict.cupboard.annotation.CompositeIndex

DEFAULT_ORDER - Static variable in annotation type nl.qbusict.cupboard.annotation.CompositeIndex

delete(String, String, String[]) - Method in interface nl.qbusict.cupboard.CupboardDatabase

delete(T) - Method in class nl.qbusict.cupboard.DatabaseCompartment

Delete an entity

delete(Class<?>, long) - Method in class nl.qbusict.cupboard.DatabaseCompartment

Delete an entity by id

delete(Class<?>, String, String...) - Method in class nl.qbusict.cupboard.DatabaseCompartment

Delete entities

delete(Uri, T) - Method in class nl.qbusict.cupboard.ProviderCompartment

Delete an entity

delete(Uri, String, String...) - Method in class nl.qbusict.cupboard.ProviderCompartment

Delete by selection.

delete(Uri, T) - Method in class nl.qbusict.cupboard.ProviderOperationsCompartment

Add a delete operation.

descending() - Method in class nl.qbusict.cupboard.convert.IndexBuilder.CompositeIndexBuilder

Set the index to be in descending order

distinct() - Method in class nl.qbusict.cupboard.DatabaseCompartment.QueryBuilder

Make this query distinct e.g.

dropAllIndices() - Method in class nl.qbusict.cupboard.DatabaseCompartment

Remove all indices for the classes registered with Cupboard.register(Class), including any indices not added by Cupboard.

dropAllTables() - Method in class nl.qbusict.cupboard.DatabaseCompartment

Drop all tables for the classes registered with Cupboard.register(Class)

E

endTransaction() - Method in interface nl.qbusict.cupboard.CupboardDatabase

EntityCompartment<T> - Class in nl.qbusict.cupboard

EntityCompartment(Cupboard, Class<T>) - Constructor for class nl.qbusict.cupboard.EntityCompartment

EntityConverter<T> - Interface in nl.qbusict.cupboard.convert

An entity converter is responsible for converting an entity to ContentValues and from a Cursor

EntityConverter.Column - Class in nl.qbusict.cupboard.convert

Holds the column name and type

EntityConverter.ColumnType - Enum in nl.qbusict.cupboard.convert

The SQLite column type

EntityConverterFactory - Interface in nl.qbusict.cupboard.convert

An entity converter factory instantiates EntityConverters.

equals(Object) - Method in class nl.qbusict.cupboard.convert.EntityConverter.Column

execSQL(String) - Method in interface nl.qbusict.cupboard.CupboardDatabase

F

FieldConverter<T> - Interface in nl.qbusict.cupboard.convert

Converts a field of type T to a column representation and vice versa

FieldConverterFactory - Interface in nl.qbusict.cupboard.convert

An field converter factory instantiates FieldConverters.

fromCursor(Cursor) - Method in interface nl.qbusict.cupboard.convert.EntityConverter

Create an entity from the cursor.

fromCursor(Cursor) - Method in class nl.qbusict.cupboard.convert.ReflectiveEntityConverter

fromCursorValue(Cursor, int) - Method in interface nl.qbusict.cupboard.convert.FieldConverter

Convert a cursor value at the specified index to an instance of T

G

get(Class<T>) - Method in class nl.qbusict.cupboard.CursorCompartment

Get the first entity from the cursor

get(Class<T>, long) - Method in class nl.qbusict.cupboard.DatabaseCompartment

Get an entity by id

get(T) - Method in class nl.qbusict.cupboard.DatabaseCompartment

Get an entity by the id set on an example entity

get() - Method in class nl.qbusict.cupboard.DatabaseCompartment.QueryBuilder

Convenience for calling DatabaseCompartment.QueryBuilder.query().get()

get(Uri, Class<T>) - Method in class nl.qbusict.cupboard.ProviderCompartment

Get an entity from a content provider

get(Uri, T) - Method in class nl.qbusict.cupboard.ProviderCompartment

Get an entity by example, the id of the entity must be set.

get() - Method in class nl.qbusict.cupboard.ProviderCompartment.QueryBuilder

Convenience for calling ProviderCompartment.QueryBuilder.query().get()

get() - Method in class nl.qbusict.cupboard.QueryResultIterable

get(boolean) - Method in class nl.qbusict.cupboard.QueryResultIterable

getColumn(Field) - Method in class nl.qbusict.cupboard.convert.ReflectiveEntityConverter

Return the column name based on the field supplied.

getColumns() - Method in interface nl.qbusict.cupboard.convert.EntityConverter

Get the database column names along with the colum types

getColumns() - Method in class nl.qbusict.cupboard.convert.ReflectiveEntityConverter

getColumnType() - Method in interface nl.qbusict.cupboard.convert.FieldConverter

Return the column type

getCursor() - Method in class nl.qbusict.cupboard.DatabaseCompartment.QueryBuilder

Convenience for calling DatabaseCompartment.QueryBuilder.query().getCursor()

getCursor() - Method in class nl.qbusict.cupboard.ProviderCompartment.QueryBuilder

Convenience for calling ProviderCompartment.QueryBuilder.query().getCursor()

getCursor() - Method in class nl.qbusict.cupboard.QueryResultIterable

getDelegateEntityConverter(EntityConverterFactory, Class<T>) - Method in class nl.qbusict.cupboard.Cupboard

Get an entity converter to be used as a delegate.

getDelegateFieldConverter(FieldConverterFactory, Type) - Method in class nl.qbusict.cupboard.Cupboard

Get a field converter to be used as a delegate.

getEntityConverter(Class<T>) - Method in class nl.qbusict.cupboard.Cupboard

Get an entity converter for an entity class.

getFieldConverter(Field) - Method in class nl.qbusict.cupboard.convert.ReflectiveEntityConverter

Get a FieldConverter for the specified field.

getFieldConverter(Type) - Method in class nl.qbusict.cupboard.Cupboard

Get a field converter for the specified Type

getId(T) - Method in interface nl.qbusict.cupboard.convert.EntityConverter

Get the id of an entity

getId(T) - Method in class nl.qbusict.cupboard.convert.ReflectiveEntityConverter

getIndexes(Field) - Method in class nl.qbusict.cupboard.convert.ReflectiveEntityConverter

getInstance() - Static method in class nl.qbusict.cupboard.CupboardFactory

getOperations() - Method in class nl.qbusict.cupboard.ProviderOperationsCompartment

Get the list of ContentProviderOperations

getRegisteredEntities() - Method in class nl.qbusict.cupboard.Cupboard

Get the classes that are registered with this instance

getTable() - Method in interface nl.qbusict.cupboard.convert.EntityConverter

Get the database table for the entity

getTable() - Method in class nl.qbusict.cupboard.convert.ReflectiveEntityConverter

getTable(Class<T>) - Method in class nl.qbusict.cupboard.Cupboard

Get the database table for an entity

getTable() - Method in class nl.qbusict.cupboard.EntityCompartment

Get the table name for this entity class

groupBy(String) - Method in class nl.qbusict.cupboard.DatabaseCompartment.QueryBuilder

Set the group by clause

H

hashCode() - Method in class nl.qbusict.cupboard.convert.EntityConverter.Column

having(String) - Method in class nl.qbusict.cupboard.DatabaseCompartment.QueryBuilder

Set the having clause

I

Ignore - Annotation Type in nl.qbusict.cupboard.annotation

Annotation interface that allows one to mark as to be ignored.

Index - Annotation Type in nl.qbusict.cupboard.annotation

Annotation interface that allows one to create an index or composite index for a column/s by specifying index_names, unique_index or unique_index_names in an Annotation.

index - Variable in class nl.qbusict.cupboard.convert.EntityConverter.Column

IndexBuilder - Class in nl.qbusict.cupboard.convert

Builder that can be used to build Index annotations.

IndexBuilder() - Constructor for class nl.qbusict.cupboard.convert.IndexBuilder

IndexBuilder.CompositeIndexBuilder - Class in nl.qbusict.cupboard.convert

insertOrThrow(String, String, ContentValues) - Method in interface nl.qbusict.cupboard.CupboardDatabase

inTransaction() - Method in interface nl.qbusict.cupboard.CupboardDatabase

isIgnored(Field) - Method in class nl.qbusict.cupboard.convert.ReflectiveEntityConverter

Check if a field should be ignored.

isReadOnlyColumn(Field) - Method in class nl.qbusict.cupboard.convert.ReflectiveEntityConverter

Return if the specified field is read only; meaning that it will never be stored, but only read from if it exists in the database.

isRegisteredEntity(Class<?>) - Method in class nl.qbusict.cupboard.Cupboard

Check if an entity class is registered.

isUseAnnotations() - Method in class nl.qbusict.cupboard.Cupboard

Return if annotations are enabled

iterate(Class<T>) - Method in class nl.qbusict.cupboard.CursorCompartment

Create a Iterable of objects.

iterator() - Method in class nl.qbusict.cupboard.QueryResultIterable

L

limit(int) - Method in class nl.qbusict.cupboard.DatabaseCompartment.QueryBuilder

Set a limit on the number of rows returned.

list(Class<T>) - Method in class nl.qbusict.cupboard.CursorCompartment

Get the contents of this cursor as a list, starting at the current position.

list() - Method in class nl.qbusict.cupboard.DatabaseCompartment.QueryBuilder

Convenience for calling DatabaseCompartment.QueryBuilder.query().list()

list() - Method in class nl.qbusict.cupboard.ProviderCompartment.QueryBuilder

Convenience for calling ProviderCompartment.QueryBuilder.query().list()

list() - Method in class nl.qbusict.cupboard.QueryResultIterable

Return the result as a list.

list(boolean) - Method in class nl.qbusict.cupboard.QueryResultIterable

Return the result as a list.

M

mCupboard - Variable in class nl.qbusict.cupboard.convert.ReflectiveEntityConverter

The Cupboard instance for this converter

mEntityClass - Variable in class nl.qbusict.cupboard.convert.ReflectiveEntityConverter

N

name - Variable in class nl.qbusict.cupboard.convert.EntityConverter.Column

named(String) - Method in class nl.qbusict.cupboard.convert.IndexBuilder.CompositeIndexBuilder

Add a new name, creating a composite index

named(String) - Method in class nl.qbusict.cupboard.convert.IndexBuilder

Set the index name to use

nl.qbusict.cupboard - package nl.qbusict.cupboard

nl.qbusict.cupboard.annotation - package nl.qbusict.cupboard.annotation

nl.qbusict.cupboard.convert - package nl.qbusict.cupboard.convert

O

offset(int) - Method in class nl.qbusict.cupboard.DatabaseCompartment.QueryBuilder

Set an offset of rows returned.

order(int) - Method in class nl.qbusict.cupboard.convert.IndexBuilder.CompositeIndexBuilder

Set the order for the composite index

orderBy(String) - Method in class nl.qbusict.cupboard.DatabaseCompartment.QueryBuilder

Set the order by clause.

orderBy(String) - Method in class nl.qbusict.cupboard.ProviderCompartment.QueryBuilder

P

ProviderCompartment - Class in nl.qbusict.cupboard

ProviderCompartment(Cupboard, Context) - Constructor for class nl.qbusict.cupboard.ProviderCompartment

ProviderCompartment.QueryBuilder<T> - Class in nl.qbusict.cupboard

ProviderOperationsCompartment - Class in nl.qbusict.cupboard

ProviderOperationsCompartment(Cupboard, ArrayList<ContentProviderOperation>) - Constructor for class nl.qbusict.cupboard.ProviderOperationsCompartment

put(Object...) - Method in class nl.qbusict.cupboard.DatabaseCompartment

Put multiple entities in a single transaction.

put(Collection<?>) - Method in class nl.qbusict.cupboard.DatabaseCompartment

Put multiple entities in a single transaction.

put(T) - Method in class nl.qbusict.cupboard.DatabaseCompartment

Put a single entity.

put(Class<?>, ContentValues) - Method in class nl.qbusict.cupboard.DatabaseCompartment

Put an entity from a ContentValues object.

put(Uri, T) - Method in class nl.qbusict.cupboard.ProviderCompartment

Put (insert) an object to a content uri.

put(Uri, Class<T>, T...) - Method in class nl.qbusict.cupboard.ProviderCompartment

Put multiple entities using ContentProvider.bulkInsert(Uri, ContentValues[])

put(Uri, Class<T>, Collection<T>) - Method in class nl.qbusict.cupboard.ProviderCompartment

Put multiple entities using ContentProvider.bulkInsert(Uri, ContentValues[])

put(Uri, T) - Method in class nl.qbusict.cupboard.ProviderOperationsCompartment

Add an insert operation to the list of operations.

put(Uri, Class<T>, T...) - Method in class nl.qbusict.cupboard.ProviderOperationsCompartment

Add multiple put operations.

Q

query(boolean, String, String[], String, String[], String, String, String, String) - Method in interface nl.qbusict.cupboard.CupboardDatabase

query(Class<T>) - Method in class nl.qbusict.cupboard.DatabaseCompartment

Query entities

query() - Method in class nl.qbusict.cupboard.DatabaseCompartment.QueryBuilder

Execute the query

query(Uri, Class<T>) - Method in class nl.qbusict.cupboard.ProviderCompartment

Query for entities

query() - Method in class nl.qbusict.cupboard.ProviderCompartment.QueryBuilder

Execute the query and return a QueryResultIterable

QueryBuilder(Uri, Class<T>, ProviderCompartment) - Constructor for class nl.qbusict.cupboard.ProviderCompartment.QueryBuilder

QueryResultIterable<T> - Class in nl.qbusict.cupboard

R

rawQuery(String, String[]) - Method in interface nl.qbusict.cupboard.CupboardDatabase

ReflectiveEntityConverter<T> - Class in nl.qbusict.cupboard.convert

The default EntityConverter

ReflectiveEntityConverter(Cupboard, Class<T>) - Constructor for class nl.qbusict.cupboard.convert.ReflectiveEntityConverter

ReflectiveEntityConverter(Cupboard, Class<T>, Collection<String>) - Constructor for class nl.qbusict.cupboard.convert.ReflectiveEntityConverter

ReflectiveEntityConverter(Cupboard, Class<T>, Collection<String>, Collection<EntityConverter.Column>) - Constructor for class nl.qbusict.cupboard.convert.ReflectiveEntityConverter

Constructor suitable for EntityConverterFactorys that only need minor changes to the default behavior of this converter, not requiring a sub class.

register(Class<T>) - Method in class nl.qbusict.cupboard.Cupboard

Register an entity class.

registerEntityConverterFactory(EntityConverterFactory) - Method in class nl.qbusict.cupboard.CupboardBuilder

Register a EntityConverterFactory

registerFieldConverter(Class<T>, FieldConverter<T>) - Method in class nl.qbusict.cupboard.CupboardBuilder

Register a field converter

registerFieldConverterFactory(FieldConverterFactory) - Method in class nl.qbusict.cupboard.CupboardBuilder

Register a FieldConverterFactory

replaceOrThrow(String, String, ContentValues) - Method in interface nl.qbusict.cupboard.CupboardDatabase

S

setCupboard(Cupboard) - Static method in class nl.qbusict.cupboard.CupboardFactory

Replace the Cupboard instance

setId(Long, T) - Method in interface nl.qbusict.cupboard.convert.EntityConverter

Set the id value on an entity

setId(Long, T) - Method in class nl.qbusict.cupboard.convert.ReflectiveEntityConverter

setTransactionSuccessful() - Method in interface nl.qbusict.cupboard.CupboardDatabase

T

toContentValue(T, String, ContentValues) - Method in interface nl.qbusict.cupboard.convert.FieldConverter

Convert an instance of T to a value that can be stored in a ContentValues object

toContentValues(T) - Method in class nl.qbusict.cupboard.EntityCompartment

Convert an entity to ContentValues

toContentValues(T, ContentValues) - Method in class nl.qbusict.cupboard.EntityCompartment

Convert an entity to ContentValues

toValues(T, ContentValues) - Method in interface nl.qbusict.cupboard.convert.EntityConverter

Convert an entity to content values Generally speaking do not add content values for columns that aren't returned from EntityConverter.getColumns() and omit columns of value EntityConverter.ColumnType.JOIN

toValues(T, ContentValues) - Method in class nl.qbusict.cupboard.convert.ReflectiveEntityConverter

type - Variable in class nl.qbusict.cupboard.convert.EntityConverter.Column

U

unique() - Method in class nl.qbusict.cupboard.convert.IndexBuilder.CompositeIndexBuilder

Make the index unique

unique() - Method in class nl.qbusict.cupboard.convert.IndexBuilder

Make this index unique

update(String, ContentValues, String, String[]) - Method in interface nl.qbusict.cupboard.CupboardDatabase

update(Class<?>, ContentValues) - Method in class nl.qbusict.cupboard.DatabaseCompartment

Update entities

update(Class<?>, ContentValues, String, String...) - Method in class nl.qbusict.cupboard.DatabaseCompartment

Update entities

update(Uri, ContentValues) - Method in class nl.qbusict.cupboard.ProviderCompartment

Update entities using the update method of ContentResolver.

update(Uri, ContentValues, String, String...) - Method in class nl.qbusict.cupboard.ProviderCompartment

Update entities using the update method of ContentResolver.

upgradeTables() - Method in class nl.qbusict.cupboard.DatabaseCompartment

Upgrade and / or create tables for the classes registered with Cupboard.register(Class) This is useful in SQLiteOpenHelper.onUpgrade(SQLiteDatabase, int, int)

useAnnotations() - Method in class nl.qbusict.cupboard.CupboardBuilder

Enable the use of annotations

V

valueOf(String) - Static method in enum nl.qbusict.cupboard.convert.EntityConverter.ColumnType

Returns the enum constant of this type with the specified name.

values() - Static method in enum nl.qbusict.cupboard.convert.EntityConverter.ColumnType

Returns an array containing the constants of this enum type, in the order they are declared.

W

withContext(Context) - Method in class nl.qbusict.cupboard.Cupboard

Operate on a ContentResolver

withCursor(Cursor) - Method in class nl.qbusict.cupboard.Cupboard

Operate on a Cursor

withDatabase(SQLiteDatabase) - Method in class nl.qbusict.cupboard.Cupboard

Operate on a SQLiteDatabase

withDatabase(CupboardDatabase) - Method in class nl.qbusict.cupboard.Cupboard

Operate on a CupboardDatabase

withEntity(Class<T>) - Method in class nl.qbusict.cupboard.Cupboard

Operate on an entity

withOperations(ArrayList<ContentProviderOperation>) - Method in class nl.qbusict.cupboard.Cupboard

Operate on a list of ContentProviderOperations

withProjection(String...) - Method in class nl.qbusict.cupboard.DatabaseCompartment.QueryBuilder

Set a projection, the columns returned, for this query.

withProjection(String...) - Method in class nl.qbusict.cupboard.ProviderCompartment.QueryBuilder

withSelection(String, String...) - Method in class nl.qbusict.cupboard.DatabaseCompartment.QueryBuilder

Set the selection (where clause) and selection arguments.

withSelection(String, String...) - Method in class nl.qbusict.cupboard.ProviderCompartment.QueryBuilder

Y

yield() - Method in class nl.qbusict.cupboard.ProviderOperationsCompartment

Allow the content provider to yield after the next operation (when supported by the provider).

yieldAfter(int) - Method in class nl.qbusict.cupboard.ProviderOperationsCompartment

Yield when the number of operations is reaches a multiple of the batch size set.

yieldIfContendedSafely() - Method in interface nl.qbusict.cupboard.CupboardDatabase

A B C D E F G H I L M N O P Q R S T U V W Y