com.blazebit.persistence.view

Annotation Type CollectionMapping

@Target(value={METHOD,PARAMETER})
 @Retention(value=RUNTIME)
public @interface CollectionMapping

Specifies the comparator that should be used for sorting. This annotation is only valid on SortedSet, NavigableSet, NavigableMap and SortedMap. The default sort order is the natural order. By using this annotation, the sort order will be overridden.

Since:

1.0.0

Author:

Christian Beikov

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends Comparator>	comparator The comparator that should be used for sorting of the collection.
boolean	ignoreIndex Specifies whether the index of the indexed collection should be ignored or not.
boolean	ordered Specifies whether entries in the collection should be ordered.

Element Detail

comparator

public abstract Class<? extends Comparator> comparator

The comparator that should be used for sorting of the collection.

Returns:

the comparator used for sorting

Default:

java.util.Comparator.class

ordered

public abstract boolean ordered

Specifies whether entries in the collection should be ordered.

Returns:

true if ordered, false otherwise

Default:

false

ignoreIndex

public abstract boolean ignoreIndex

Specifies whether the index of the indexed collection should be ignored or not.

Returns:

true if the index should be ignored, false otherwise

Default:

false