Index

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

A

Additional Method Parameters - Search tag in module jakarta.data
Section
afterKeyset(Object...) - Method in interface jakarta.data.page.Pageable
Requests keyset pagination in the forward direction, starting after the specified keyset values.
afterKeysetCursor(Pageable.Cursor) - Method in interface jakarta.data.page.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.Sort
Create a Sort instance with ascending direction that does not request case insensitive ordering.
ASC - Enum constant in enum class jakarta.data.Direction
Ascending direction.
ascIgnoreCase(String) - Static method in record class jakarta.data.Sort
Create a Sort instance with ascending direction and case insensitive ordering.

B

BasicRepository<T,K> - Interface in jakarta.data.repository
A built-in repository supertype for performing basic operations on entities.
beforeKeyset(Object...) - Method in interface jakarta.data.page.Pageable
Requests keyset pagination in the reverse direction, starting after the specified keyset values.
beforeKeysetCursor(Pageable.Cursor) - Method in interface jakarta.data.page.Pageable
Requests keyset pagination in the reverse direction, starting after the specified keyset values.
By - Annotation Interface in jakarta.data.repository
Annotates a parameter of a repository method to specify the name of an entity attribute against which to compare.

C

content() - Method in interface jakarta.data.page.Slice
Returns the page content as a List.
count() - Method in interface jakarta.data.repository.BasicRepository
Retrieves the total number of persistent entities of the specified type in the database.
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
A built-in repository supertype for performing Create, Read, Update, and Delete (CRUD) operations on entities.
cursor() - Method in interface jakarta.data.page.Pageable
Returns the keyset values which are the starting point for keyset pagination.
CURSOR_NEXT - Enum constant in enum class jakarta.data.page.Pageable.Mode
Indicates forward keyset pagination, which follows the direction of the sort criteria, using a cursor that is formed from the keyset of the last entity on the current page.
CURSOR_PREVIOUS - Enum constant in enum class jakarta.data.page.Pageable.Mode
Indicates a request for a page with keyset pagination in the reverse direction of the sort criteria, using a cursor that is formed from the keyset of first entity on the current page.

D

Database Support for Keyset Pagination - Search tag in interface jakarta.data.page.KeysetAwareSlice
Section
DataConnectionException - Exception Class in jakarta.data.exceptions
Indicates a connection-related failure that might be intermittent in nature.
DataConnectionException(String) - Constructor for exception class jakarta.data.exceptions.DataConnectionException
Constructs a new DataConnectionException exception with the specified detail message.
DataConnectionException(String, Throwable) - Constructor for exception class jakarta.data.exceptions.DataConnectionException
Constructs a new DataConnectionException exception with the specified detail message.
DataConnectionException(Throwable) - Constructor for exception class jakarta.data.exceptions.DataConnectionException
Constructs a new DataConnectionException exception with the specified cause.
DataException - Exception Class in jakarta.data.exceptions
Thrown by the data provider when a problem occurs.
DataException(String) - Constructor for exception class jakarta.data.exceptions.DataException
Constructs a new DataException exception with the specified detail message.
DataException(String, Throwable) - Constructor for exception class jakarta.data.exceptions.DataException
Constructs a new DataException exception with the specified detail message and cause.
DataException(Throwable) - Constructor for exception class jakarta.data.exceptions.DataException
Constructs a new DataException exception with the specified cause.
DataRepository<T,K> - Interface in jakarta.data.repository
A built-in repository supertype that is the root of all other built-in repository supertype interfaces.
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.BasicRepository
Deletes a given entity.
Delete - Annotation Interface in jakarta.data.repository
Annotates a repository method to perform delete operations.
deleteAll() - Method in interface jakarta.data.repository.BasicRepository
Deletes all persistent entities managed by the repository.
deleteAll(Iterable<? extends T>) - Method in interface jakarta.data.repository.BasicRepository
Deletes the given entities.
deleteById(K) - Method in interface jakarta.data.repository.BasicRepository
Deletes the entity with the given Id.
deleteByIdIn(Iterable<K>) - Method in interface jakarta.data.repository.BasicRepository
Deletes all instances of the type T with the given Ids.
desc(String) - Static method in record class jakarta.data.Sort
Create a Sort instance with descending direction that does not request case insensitive ordering.
DESC - Enum constant in enum class jakarta.data.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.Sort
Create a Sort instance with descending direction and case insensitive ordering.
Direction - Enum Class in jakarta.data
Represents the direction of the ordering.

E

EmptyResultException - Exception Class 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 class jakarta.data.exceptions.EmptyResultException
Constructs a new EmptyResultException exception with the specified detail message.
EmptyResultException(String, Throwable) - Constructor for exception class jakarta.data.exceptions.EmptyResultException
Constructs a new EmptyResultException exception with the specified detail message.
EmptyResultException(Throwable) - Constructor for exception class jakarta.data.exceptions.EmptyResultException
Constructs a new EmptyResultException exception with the specified cause.
EntityExistsException - Exception Class in jakarta.data.exceptions
Indicates that an entity cannot be inserted into the database because an entity with same unique identifier already exists in the database.
EntityExistsException(String) - Constructor for exception class jakarta.data.exceptions.EntityExistsException
Constructs a new EntityExistsException with the specified detail message.
EntityExistsException(String, Throwable) - Constructor for exception class jakarta.data.exceptions.EntityExistsException
Constructs a new EntityExistsException with the specified detail message and cause.
EntityExistsException(Throwable) - Constructor for exception class jakarta.data.exceptions.EntityExistsException
Constructs a new EntityExistsException with the specified cause.
equals(Object) - Method in record class jakarta.data.Limit
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in interface jakarta.data.page.Pageable.Cursor
Returns whether or not the keyset values of this cursor are equal to those of the supplied cursor.
equals(Object) - Method in interface jakarta.data.page.Pageable
Compares with another instance to determine if both represent the same pagination information.
equals(Object) - Method in record class jakarta.data.Sort
Indicates whether some other object is "equal to" this one.
existsById(K) - Method in interface jakarta.data.repository.BasicRepository
Returns whether an entity with the given Id exists.

F

findAll() - Method in interface jakarta.data.repository.BasicRepository
Retrieves all persistent entities of the specified type from the database.
findAll(Pageable) - Method in interface jakarta.data.repository.PageableRepository
Returns a Page of entities according to the page request that is provided as the Pageable parameter.
findById(K) - Method in interface jakarta.data.repository.BasicRepository
Retrieves an entity by its Id.
findByIdIn(Iterable<K>) - Method in interface jakarta.data.repository.BasicRepository
Returns all instances of the type T with the given Ids.

G

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

H

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

I

Identifying the type of Entity - Search tag in module jakarta.data
Section
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.Sort
Indicates whether or not to request case insensitive ordering from a database with case sensitive collation.
insert(S) - Method in interface jakarta.data.repository.CrudRepository
Inserts an entity into the database.
Insert - Annotation Interface in jakarta.data.repository
Annotates a repository method that inserts entities.
insertAll(Iterable<S>) - Method in interface jakarta.data.repository.CrudRepository
Inserts multiple entities into the database.
Interceptor Annotations on Repository Methods - Search tag in module jakarta.data
Section
isAscending() - Method in record class jakarta.data.Sort
Indicates whether to sort the property in ascending order (true) or descending order (false).
isDescending() - Method in record class jakarta.data.Sort
Indicates whether to sort the property in descending order (true) or ascending order (false).

J

jakarta.data - module jakarta.data
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 - package jakarta.data
Jakarta Data provides an API that simplifies data access.
jakarta.data.exceptions - package jakarta.data.exceptions
Common data access exceptions.
jakarta.data.page - package jakarta.data.page
Splits query results into slices or pages.
jakarta.data.repository - package jakarta.data.repository
A repository is an interface annotated with Repository that defines operations on entities.
Jakarta Persistence - Search tag in module jakarta.data
Section
Jakarta Transactions - Search tag in module jakarta.data
Section
Jakarta Validation - Search tag in module jakarta.data
Section

K

KeysetAwarePage<T> - Interface in jakarta.data.page
A page of data with the ability to create a cursor from the keyset of each entity in the page.
KeysetAwareSlice<T> - Interface in jakarta.data.page
A slice of data with the ability to create a cursor from the keyset of each entity in the slice.
Keyset Pagination with Query - Search tag in interface jakarta.data.page.KeysetAwareSlice
Section

L

Limit - Record Class in jakarta.data
Limits how many results are retrieved by a repository find method.
Limit(int, long) - Constructor for record class jakarta.data.Limit
Limits query results.
Limits - Search tag in module jakarta.data
Section
Logical Operator Precedence - Search tag in module jakarta.data
Section

M

MappingException - Exception Class 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 class jakarta.data.exceptions.MappingException
Constructs a new MappingException exception with the specified detail message.
MappingException(String, Throwable) - Constructor for exception class jakarta.data.exceptions.MappingException
Constructs a new MappingException exception with the specified detail message.
MappingException(Throwable) - Constructor for exception class jakarta.data.exceptions.MappingException
Constructs a new MappingException exception with the specified cause.
maxResults() - Method in record class jakarta.data.Limit
Maximum number of results that can be returned for a single invocation of the repository method.
Methods with Entity Parameters - Search tag in module jakarta.data
Section
mode() - Method in interface jakarta.data.page.Pageable
Returns the type of pagination.

N

next() - Method in interface jakarta.data.page.Pageable
Returns the Pageable requesting the next page if using offset pagination.
nextPageable() - Method in interface jakarta.data.page.KeysetAwareSlice
Creates a request for the next page in a forward direction from the current page.
nextPageable() - Method in interface jakarta.data.page.Slice
Returns a request for the next page, or null if it is known that there is no next page.
NonUniqueResultException - Exception Class 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 class jakarta.data.exceptions.NonUniqueResultException
Constructs a new NonUniqueResultException exception with the specified detail message.
NonUniqueResultException(String, Throwable) - Constructor for exception class jakarta.data.exceptions.NonUniqueResultException
Constructs a new NonUniqueResultException exception with the specified detail message.
NonUniqueResultException(Throwable) - Constructor for exception class jakarta.data.exceptions.NonUniqueResultException
Constructs a new NonUniqueResultException exception with the specified cause.
numberOfElements() - Method in interface jakarta.data.page.Slice
Returns the number of elements in this Slice, which must be no larger than the maximum size of the page request.

O

of(int) - Static method in record class jakarta.data.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.Sort
Create a Sort instance
OFFSET - Enum constant in enum class jakarta.data.page.Pageable.Mode
Indicates a request for a page using offset pagination.
ofPage(long) - Static method in interface jakarta.data.page.Pageable
Creates a new page request with the given page number and with a default size of 10.
ofSize(int) - Static method in interface jakarta.data.page.Pageable
Creates a new page request for requesting pages of the specified size, starting with the first page number, which is 1.
OptimisticLockingFailureException - Exception Class in jakarta.data.exceptions
Indicates a failure that is due to inconsistent state between the entity and the database.
OptimisticLockingFailureException(String) - Constructor for exception class jakarta.data.exceptions.OptimisticLockingFailureException
Constructs a new OptimisticLockingFailureException exception with the specified detail message.
OptimisticLockingFailureException(String, Throwable) - Constructor for exception class jakarta.data.exceptions.OptimisticLockingFailureException
Constructs a new OptimisticLockingFailureException exception with the specified detail message.
OptimisticLockingFailureException(Throwable) - Constructor for exception class 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 method.

P

page() - Method in interface jakarta.data.page.Pageable
Returns the page to be returned.
page(long) - Method in interface jakarta.data.page.Pageable
Creates a new page request with the same pagination information, except with the specified page number.
Page<T> - Interface in jakarta.data.page
A page contains the data that is retrieved for a page request and has awareness of the total number of pages.
pageable() - Method in interface jakarta.data.page.Slice
Returns the page request for which this slice was obtained.
Pageable - Interface in jakarta.data.page
A request for a page or slice.
Pageable.Cursor - Interface in jakarta.data.page
A cursor that is formed from a keyset, relative to which a next or previous page can be requested.
Pageable.Mode - Enum Class in jakarta.data.page
The type of pagination: offset-based or keyset cursor-based, which includes a direction.
PageableRepository<T,K> - Interface in jakarta.data.repository
A built-in repository supertype with methods that use pagination and sorting to retreive entities.
Page Numbers and Totals - Search tag in interface jakarta.data.page.KeysetAwareSlice
Section
Pagination - Search tag in module jakarta.data
Section
Param - Annotation Interface in jakarta.data.repository
Annotates a parameter of a repository method to bind it to a named parameter of a Query.
Parameter-based Conditions - Search tag in module jakarta.data
Section
Persistence Context - Search tag in module jakarta.data
Section
Precedence of Repository Methods - Search tag in module jakarta.data
Section
previousPageable() - Method in interface jakarta.data.page.KeysetAwareSlice
Creates a request for the previous page in a reverse direction from the current page.
property() - Method in record class jakarta.data.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
Annotates a repository method to specify a query string such as SQL, JPQL, Cypher etc.
Query by Method Name - Search tag in module jakarta.data
Section

R

range(long, long) - Static method in record class jakarta.data.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 repository interface to be implemented by the container/runtime.
Repository Default Methods - Search tag in module jakarta.data
Section
Reserved for Future Use - Search tag in module jakarta.data
Section
Reserved Keywords for Query by Method Name - Search tag in module jakarta.data
Section
Resource Accessor Methods - Search tag in module jakarta.data
Section
Return Types for Annotated Methods - Search tag in module jakarta.data
Section
Return Types for Repository Methods - Search tag in module jakarta.data
Section

S

save(S) - Method in interface jakarta.data.repository.BasicRepository
Saves a given entity to the database.
Save - Annotation Interface in jakarta.data.repository
Annotates a repository method that updates entities if found in the database and inserts entities into the database that are not found.
saveAll(Iterable<S>) - Method in interface jakarta.data.repository.BasicRepository
Saves all given entities to the database.
size() - Method in interface jakarta.data.page.Pageable.Cursor
Returns the number of values in the keyset.
size() - Method in interface jakarta.data.page.Pageable
Returns the requested size of each page
size(int) - Method in interface jakarta.data.page.Pageable
Creates a new page request with the same pagination information, except with the specified maximum page size.
Slice<T> - Interface in jakarta.data.page
A slice contains the data that is retrieved for a page request.
Sort - Record Class in jakarta.data
Requests sorting on a given entity attribute.
Sort(String, boolean, boolean) - Constructor for record class jakarta.data.Sort
Defines sort criteria for an entity property.
sortBy(Sort...) - Method in interface jakarta.data.page.Pageable
Creates a new page request with the same pagination information, except using the specified sort criteria.
sortBy(Iterable<Sort>) - Method in interface jakarta.data.page.Pageable
Creates a new page request with the same pagination information, except using the specified sort criteria.
Sorting at Runtime - Search tag in module jakarta.data
Section
sorts() - Method in interface jakarta.data.page.Pageable
Return the order collection if it was specified on this page request, otherwise an empty list.
startAt() - Method in record class jakarta.data.Limit
Offset at which to start when returning query results.
stream() - Method in interface jakarta.data.Streamable
Returns a sequential stream of results, which follow the order of the sort criteria if specified.
Streamable<T> - Interface in jakarta.data
An interface for sequential streaming of an Iterable.

T

toString() - Method in record class jakarta.data.Limit
Returns a string representation of this record class.
toString() - Method in interface jakarta.data.page.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.Sort
Returns a string representation of this record class.
totalElements() - Method in interface jakarta.data.page.Page
Returns the total number of elements across all pages that can be requested for the query.
totalPages() - Method in interface jakarta.data.page.Page
Returns the total number of pages.

U

update(T) - Method in interface jakarta.data.repository.CrudRepository
Modifies an entity that already exists in the database.
Update - Annotation Interface in jakarta.data.repository
Annotates a repository method to perform update operations.
updateAll(Iterable<T>) - Method in interface jakarta.data.repository.CrudRepository
Modifies entities that already exist in the database.

V

value() - Element in annotation interface jakarta.data.repository.By
The name of the entity attribute against which to compare.
value() - Element in annotation interface jakarta.data.repository.OrderBy.List
Returns a list of annotations with the first taking precedence, followed by the second, and so forth.
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 query language named 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.Direction
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class jakarta.data.page.Pageable.Mode
Returns the enum constant of this class with the specified name.
values() - Static method in enum class jakarta.data.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.page.Pageable.Mode
Returns an array containing the constants of this enum class, in the order they are declared.

W

Wildcard Characters - Search tag in module jakarta.data
Section
A B C D E F G H I J K L M N O P Q R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form