Index

A B C D E F G H I J K L M N O P Q R S T V 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

afterKeyset(Object...) - Method in interface jakarta.data.repository.Pageable
Requests keyset pagination in the forward direction, starting after the specified keyset values.
afterKeysetCursor(Pageable.Cursor) - Method in interface jakarta.data.repository.Pageable
Requests keyset pagination in the forward direction, starting after the specified keyset values.
ANY_PROVIDER - Static variable in annotation interface jakarta.data.repository.Repository
Value for the Repository.provider() attribute that allows the use of any available Jakarta Data provider that supports the type of entity annotation that is present on the repository's entity class.
asc(String) - Static method in record class jakarta.data.repository.Sort
Create a Sort instance with ascending direction Direction.ASC that does not request case insensitive ordering.
ASC - Enum constant in enum class jakarta.data.repository.Direction
Ascending direction.
ascIgnoreCase(String) - Static method in record class jakarta.data.repository.Sort
Create a Sort instance with ascending direction Direction.ASC and case insensitive ordering.

B

beforeKeyset(Object...) - Method in interface jakarta.data.repository.Pageable
Requests keyset pagination in the reverse direction, starting after the specified keyset values.
beforeKeysetCursor(Pageable.Cursor) - Method in interface jakarta.data.repository.Pageable
Requests keyset pagination in the reverse direction, starting after the specified keyset values.

C

content() - Method in interface jakarta.data.repository.Slice
Returns the page content as List.
count() - Method in interface jakarta.data.repository.CrudRepository
Returns the number of entities available.
count() - Element in annotation interface jakarta.data.repository.Query
Defines an additional query that counts the number of elements that are returned by the primary query.
CrudRepository<T,K> - Interface in jakarta.data.repository
Interface for generic CRUD operations on a repository for a specific type.
cursor() - Method in interface jakarta.data.repository.Pageable
Returns the keyset values which are the starting point for keyset pagination.
CURSOR_NEXT - Enum constant in enum class jakarta.data.repository.Pageable.Mode
Indicates forward keyset pagination, which follows the direction of the OrderBy annotations, Pageable.sortBy(Sort...) or Pageable.sortBy(Iterable) parameters, repository method Sort parameters, or OrderBy name pattern of the repository method.
CURSOR_PREVIOUS - Enum constant in enum class jakarta.data.repository.Pageable.Mode
Indicates a request for a page with keyset pagination in the reverse direction of the OrderBy annotations, Pageable.sortBy(Sort...) or Pageable.sortBy(Iterable) parameters, repository method Sort parameters, or OrderBy name pattern of the repository method.

D

DataConnectionException - Exception in jakarta.data.exceptions
Indicates a connection-related failure that might be intermittent in nature.
DataConnectionException(String) - Constructor for exception jakarta.data.exceptions.DataConnectionException
Constructs a new DataConnectionException exception with the specified detail message.
DataConnectionException(String, Throwable) - Constructor for exception jakarta.data.exceptions.DataConnectionException
Constructs a new DataConnectionException exception with the specified detail message.
DataConnectionException(Throwable) - Constructor for exception jakarta.data.exceptions.DataConnectionException
Constructs a new DataConnectionException exception with the specified cause.
DataException - Exception in jakarta.data.exceptions
Thrown by the data provider when a problem occurs.
DataException(String) - Constructor for exception jakarta.data.exceptions.DataException
Constructs a new DataException exception with the specified detail message.
DataException(String, Throwable) - Constructor for exception jakarta.data.exceptions.DataException
Constructs a new DataException exception with the specified detail message and cause.
DataException(Throwable) - Constructor for exception jakarta.data.exceptions.DataException
Constructs a new DataException exception with the specified cause.
DataRepository<T,K> - Interface in jakarta.data.repository
Parent repository interface for all repositories.
dataStore() - Element in annotation interface jakarta.data.repository.Repository
Optionally indicates the data store to use for the repository.
DEFAULT_DATA_STORE - Static variable in annotation interface jakarta.data.repository.Repository
Value for the Repository.dataStore() attribute that indicates that the Jakarta Data provider should choose a default data store to use.
delete(T) - Method in interface jakarta.data.repository.CrudRepository
Deletes a given entity.
deleteAll() - Method in interface jakarta.data.repository.CrudRepository
Deletes all entities managed by the repository.
deleteAll(Iterable<? extends T>) - Method in interface jakarta.data.repository.CrudRepository
Deletes the given entities.
deleteAllById(Iterable<K>) - Method in interface jakarta.data.repository.CrudRepository
Deletes all instances of the type T with the given IDs.
deleteById(K) - Method in interface jakarta.data.repository.CrudRepository
Deletes the entity with the given id.
desc(String) - Static method in record class jakarta.data.repository.Sort
Create a Sort instance with descending direction Direction.DESC that does not request case insensitive ordering.
DESC - Enum constant in enum class jakarta.data.repository.Direction
Descending direction.
descending() - Element in annotation interface jakarta.data.repository.OrderBy
Indicate whether to use descending order when sorting by this attribute.
descIgnoreCase(String) - Static method in record class jakarta.data.repository.Sort
Create a Sort instance with descending direction Direction.DESC and case insensitive ordering.
Direction - Enum Class in jakarta.data.repository
Represents the direction of the ordering.

E

EmptyResultException - Exception in jakarta.data.exceptions
Data access exception thrown when a result was expected to have at least one row (or element) but zero rows (or elements) were actually returned.
EmptyResultException(String) - Constructor for exception jakarta.data.exceptions.EmptyResultException
Constructs a new EmptyResultException exception with the specified detail message.
EmptyResultException(String, Throwable) - Constructor for exception jakarta.data.exceptions.EmptyResultException
Constructs a new EmptyResultException exception with the specified detail message.
EmptyResultException(Throwable) - Constructor for exception jakarta.data.exceptions.EmptyResultException
Constructs a new EmptyResultException exception with the specified cause.
equals(Object) - Method in record class jakarta.data.repository.Limit
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in interface jakarta.data.repository.Pageable.Cursor
Returns whether or not the keyset values of this instance are equal to those of the supplied instance.
equals(Object) - Method in interface jakarta.data.repository.Pageable
Compares with another instance to determine if both represent the same pagination information.
equals(Object) - Method in record class jakarta.data.repository.Sort
Indicates whether some other object is "equal to" this one.
existsById(K) - Method in interface jakarta.data.repository.CrudRepository
Returns whether an entity with the given id exists.

F

findAll() - Method in interface jakarta.data.repository.CrudRepository
Returns all instances of the type.
findAll(Pageable) - Method in interface jakarta.data.repository.PageableRepository
Returns a Page of entities meeting the paging restriction provided in the Pageable object.
findAllById(Iterable<K>) - Method in interface jakarta.data.repository.CrudRepository
Returns all instances of the type T with the given IDs.
findById(K) - Method in interface jakarta.data.repository.CrudRepository
Retrieves an entity by its id.

G

getKeysetCursor(int) - Method in interface jakarta.data.repository.KeysetAwareSlice
Returns a Cursor for keyset values at the specified position.
getKeysetElement(int) - Method in interface jakarta.data.repository.Pageable.Cursor
Returns the keyset value at the specified position.

H

hasContent() - Method in interface jakarta.data.repository.Slice
Returns whether the Slice has content at all.
hashCode() - Method in record class jakarta.data.repository.Limit
Returns a hash code value for this object.
hashCode() - Method in interface jakarta.data.repository.Pageable.Cursor
Returns a hash code based on the keyset values.
hashCode() - Method in record class jakarta.data.repository.Sort
Returns a hash code value for this object.

I

ignoreCase() - Element in annotation interface jakarta.data.repository.OrderBy
Indicates whether or not to request case insensitive ordering from a database with case sensitive collation.
ignoreCase() - Method in record class jakarta.data.repository.Sort
Indicates whether or not to request case insensitive ordering from a database with case sensitive collation.
isAscending() - Method in record class jakarta.data.repository.Sort
Indicates whether to sort the property in ascending order (true) or descending order (false).
isDescending() - Method in record class jakarta.data.repository.Sort
Indicates whether to sort the property in descending order (true) or ascending order (false).

J

jakarta.data.api - module jakarta.data.api
Jakarta Data standardizes a programming model where data is represented by simple Java classes and where operations on data are represented by interface methods.
jakarta.data.exceptions - package jakarta.data.exceptions
Common data access exceptions.
jakarta.data.repository - package jakarta.data.repository
In Domain-driven design, DDD, a repository is an object that participates in the domain but abstracts away storage and infrastructure details.

K

KeysetAwarePage<T> - Interface in jakarta.data.repository
A page of results from a repository query that performs keyset pagination.
KeysetAwareSlice<T> - Interface in jakarta.data.repository
Keyset pagination is a form of pagination that aims to reduce the possibility of missed or duplicate results by making the request for each subsequent page relative to the observed values of entity properties from the current page.

L

Limit - Record Class in jakarta.data.repository
Limits the number of results of a single invocation of a repository find method to a maximum amount or to within a positional range.
Limit(int, long) - Constructor for record class jakarta.data.repository.Limit
Limits query results.

M

MappingException - Exception in jakarta.data.exceptions
A mapping exception is one thrown if an issue exists at runtime or build time in the data mapping.
MappingException(String) - Constructor for exception jakarta.data.exceptions.MappingException
Constructs a new MappingException exception with the specified detail message.
MappingException(String, Throwable) - Constructor for exception jakarta.data.exceptions.MappingException
Constructs a new MappingException exception with the specified detail message.
MappingException(Throwable) - Constructor for exception jakarta.data.exceptions.MappingException
Constructs a new MappingException exception with the specified cause.
maxResults() - Method in record class jakarta.data.repository.Limit
Maximum number of results that can be returned for a single invocation of the repository method.
mode() - Method in interface jakarta.data.repository.Pageable
Returns the type of pagination.

N

next() - Method in interface jakarta.data.repository.Pageable
Returns the Pageable requesting the next page if using offset pagination.
nextPageable() - Method in interface jakarta.data.repository.KeysetAwareSlice
Returns pagination information for requesting the next page in a forward direction from the current page.
nextPageable() - Method in interface jakarta.data.repository.Slice
Returns the next Pageable.next(), or null if it is known that there is no next page.
NonUniqueResultException - Exception in jakarta.data.exceptions
This exception is raised when execution of a repository method with a singular return type finds multiple results.
NonUniqueResultException(String) - Constructor for exception jakarta.data.exceptions.NonUniqueResultException
Constructs a new NonUniqueResultException exception with the specified detail message.
NonUniqueResultException(String, Throwable) - Constructor for exception jakarta.data.exceptions.NonUniqueResultException
Constructs a new NonUniqueResultException exception with the specified detail message.
NonUniqueResultException(Throwable) - Constructor for exception jakarta.data.exceptions.NonUniqueResultException
Constructs a new NonUniqueResultException exception with the specified cause.
numberOfElements() - Method in interface jakarta.data.repository.Slice
Returns the number of elements currently on this Slice.

O

of(int) - Static method in record class jakarta.data.repository.Limit
Create a limit that caps the number of results at the specified maximum, starting from the first result.
of(String, Direction, boolean) - Static method in record class jakarta.data.repository.Sort
Create a Sort instance
OFFSET - Enum constant in enum class jakarta.data.repository.Pageable.Mode
Indicates a reqeust for a page using offset pagination.
ofPage(long) - Static method in interface jakarta.data.repository.Pageable
Creates a new Pageable with the given page number and with a default size of 10.
ofSize(int) - Static method in interface jakarta.data.repository.Pageable
Creates a new Pageable for requesting pages of the specified size, starting with the first page number, which is 1.
OptimisticLockingFailureException - Exception in jakarta.data.exceptions
Indicates a failure that is due to inconsistent state between the entity and the database.
OptimisticLockingFailureException(String) - Constructor for exception jakarta.data.exceptions.OptimisticLockingFailureException
Constructs a new OptimisticLockingFailureException exception with the specified detail message.
OptimisticLockingFailureException(String, Throwable) - Constructor for exception jakarta.data.exceptions.OptimisticLockingFailureException
Constructs a new OptimisticLockingFailureException exception with the specified detail message.
OptimisticLockingFailureException(Throwable) - Constructor for exception jakarta.data.exceptions.OptimisticLockingFailureException
Constructs a new OptimisticLockingFailureException exception with the specified cause.
OrderBy - Annotation Interface in jakarta.data.repository
Annotates a repository method to request sorting of results.
OrderBy.List - Annotation Interface in jakarta.data.repository
Enables multiple OrderBy annotations on the same type.

P

page() - Method in interface jakarta.data.repository.Pageable
Returns the page to be returned.
page(long) - Method in interface jakarta.data.repository.Pageable
Creates a new Pageable instance representing the same pagination information, except with the specified page number.
Page<T> - Interface in jakarta.data.repository
A page is a sublist of results.
pageable() - Method in interface jakarta.data.repository.Slice
Returns the current Pageable
Pageable - Interface in jakarta.data.repository
This class represents pagination information.
Pageable.Cursor - Interface in jakarta.data.repository
Represents keyset values, which can be a starting point for requesting a next or previous page.
Pageable.Mode - Enum Class in jakarta.data.repository
The type of pagination, which can be offset pagination or keyset cursor pagination which includes a direction.
PageableRepository<T,K> - Interface in jakarta.data.repository
Repository fragment to provide methods to retrieve entities using the pagination and sorting abstraction.
Param - Annotation Interface in jakarta.data.repository
Annotation to bind method parameters to a Query via a named parameter.
previousPageable() - Method in interface jakarta.data.repository.KeysetAwareSlice
Returns pagination information for requesting the previous page in a reverse direction from the current page.
property() - Method in record class jakarta.data.repository.Sort
Name of the property to order by.
provider() - Element in annotation interface jakarta.data.repository.Repository
Restricts the repository implementation to that of a specific Jakarta Data provider.

Q

Query - Annotation Interface in jakarta.data.repository
Defines the query string such as SQL, JPA-QL, Cypher etc.

R

range(long, long) - Static method in record class jakarta.data.repository.Limit
Create a limit that restricts the results to a range, beginning with the startAt position and ending after the endAt position or the position of the final result, whichever comes first.
Repository - Annotation Interface in jakarta.data.repository
Annotates a data repository interface that will be implemented by the container/runtime.

S

save(S) - Method in interface jakarta.data.repository.CrudRepository
Saves a given entity.
saveAll(Iterable<S>) - Method in interface jakarta.data.repository.CrudRepository
Saves all given entities.
size() - Method in interface jakarta.data.repository.Pageable.Cursor
Returns the number of values in the keyset.
size() - Method in interface jakarta.data.repository.Pageable
Returns the requested size of each page
size(int) - Method in interface jakarta.data.repository.Pageable
Creates a new Pageable instance representing the same pagination information, except with the specified maximum page size.
Slice<T> - Interface in jakarta.data.repository
A slice of data that indicates whether there's a next or previous slice available.
Sort - Record Class in jakarta.data.repository
Sort allows the application to dynamically provide sort criteria which includes a case sensitivity request, a Direction and a property.
Sort(String, boolean, boolean) - Constructor for record class jakarta.data.repository.Sort
Defines sort criteria for an entity property.
sortBy(Sort...) - Method in interface jakarta.data.repository.Pageable
Creates a new Pageable instance representing the same pagination information, except using the specified sort criteria.
sortBy(Iterable<Sort>) - Method in interface jakarta.data.repository.Pageable
Creates a new Pageable instance representing the same pagination information, except using the specified sort criteria.
sorts() - Method in interface jakarta.data.repository.Pageable
Return the order collection if it was specified on this Pageable, otherwise an empty list.
startAt() - Method in record class jakarta.data.repository.Limit
Offset at which to start when returning query results.
stream() - Method in interface jakarta.data.repository.Streamable
Returns a sequential stream of results, which follow the order of the sort criteria if specified.
Streamable<T> - Interface in jakarta.data.repository
Simple interface to ease streamability of Iterables.

T

toString() - Method in record class jakarta.data.repository.Limit
Returns a string representation of this record class.
toString() - Method in interface jakarta.data.repository.Pageable.Cursor
String representation of the keyset cursor, including the number of key values in the cursor but not the values themselves.
toString() - Method in record class jakarta.data.repository.Sort
Returns a string representation of this record class.
totalElements() - Method in interface jakarta.data.repository.Page
Returns the total amount of elements.
totalPages() - Method in interface jakarta.data.repository.Page
Returns the total number of pages.

V

value() - Element in annotation interface jakarta.data.repository.OrderBy.List
 
value() - Element in annotation interface jakarta.data.repository.OrderBy
Entity attribute name to sort by.
value() - Element in annotation interface jakarta.data.repository.Param
Defines the name of the parameter to bind to.
value() - Element in annotation interface jakarta.data.repository.Query
Defines the query to be executed when the annotated method is called.
valueOf(String) - Static method in enum class jakarta.data.repository.Direction
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class jakarta.data.repository.Pageable.Mode
Returns the enum constant of this class with the specified name.
values() - Static method in enum class jakarta.data.repository.Direction
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class jakarta.data.repository.Pageable.Mode
Returns an array containing the constants of this enum class, in the order they are declared.
A B C D E F G H I J K L M N O P Q R S T V 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form