Package com.blazebit.persistence.deltaspike.data.rest

Annotation Type KeysetConfig

@Retention(RUNTIME)
@Target(PARAMETER)
public @interface KeysetConfig

Required configuration for a KeysetPageable that specifies the keyset element type.

Since:

1.2.0

Author:

Christian Beikov

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	highestName	The query parameter name for the highest keyset parameter.
Class<?>	keysetClass	Alias for value().
String	lowestName	The query parameter name for the lowest keyset parameter.
String	previousOffsetName	The query parameter name for the previous offset parameter.
String	previousPageName	The query parameter name for the previous page parameter.
String	previousPageSizeName	The query parameter name for the previous page size parameter.
Class<?>	value	The keyset element type.

Element Details

value

Class<?> value

The keyset element type. Usually the entity type or the DTO type representing the result element type.

Returns:

The keyset element type.

Default:

void.class

keysetClass

Class<?> keysetClass

Alias for value().

Returns:

The keyset element type

Default:

void.class

previousOffsetName

String previousOffsetName

The query parameter name for the previous offset parameter. If empty, the value from KeysetPageableConfiguration.getPreviousOffsetParameterName() is used.

Returns:

The previous offset query parameter name

Since:

1.3.0

Default:

""

previousPageName

String previousPageName

The query parameter name for the previous page parameter. If empty, the value from KeysetPageableConfiguration.getPreviousPageParameterName() is used.

Returns:

The previous page query parameter name

Default:

""

previousPageSizeName

String previousPageSizeName

The query parameter name for the previous page size parameter. If empty, the value from KeysetPageableConfiguration.getPreviousSizeParameterName() ()} is used.

Returns:

The previous page size query parameter name

Default:

""

lowestName

String lowestName

The query parameter name for the lowest keyset parameter. If empty, the value from KeysetPageableConfiguration.getLowestParameterName() ()} is used.

Returns:

The lowest keyset query parameter name

Default:

""

highestName

String highestName

The query parameter name for the highest keyset parameter. If empty, the value from KeysetPageableConfiguration.getHighestParameterName() ()} is used.

Returns:

The highest keyset query parameter name

Default:

""