nl.qbusict.cupboard.convert

Class IndexBuilder

java.lang.Object

nl.qbusict.cupboard.convert.IndexBuilder

public class IndexBuilder
extends java.lang.Object

Builder that can be used to build Index annotations. This is useful for custom EntityConverters to specify their column indices in a EntityConverter.Column. For example ReflectiveEntityConverter will only process annotations when Cupboard.isUseAnnotations() is true. By overriding ReflectiveEntityConverter.getIndexes(java.lang.reflect.Field) the indices can be constructed in code using this builder, without the need for reflection.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	IndexBuilder.CompositeIndexBuilder

Constructor Summary

Constructors

Constructor and Description
IndexBuilder()

Method Summary

Modifier and Type	Method and Description
Index	build() Build the index
IndexBuilder.CompositeIndexBuilder	named(java.lang.String name) Set the index name to use
IndexBuilder	unique() Make this index unique

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndexBuilder

public IndexBuilder()

Method Detail

named

public IndexBuilder.CompositeIndexBuilder named(java.lang.String name)

Set the index name to use

Parameters:

name - the index name

Returns:

a IndexBuilder.CompositeIndexBuilder for chaining

unique

public IndexBuilder unique()

Make this index unique

Returns:

the builder for chaining

build

public Index build()

Build the index

Returns:

the index