Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- afterCursor(PageRequest.Cursor) - Method in interface jakarta.data.page.PageRequest
-
Requests
cursor-based pagination
in the forward direction, starting after the specified key. - afterKey(Object...) - Method in interface jakarta.data.page.PageRequest
-
Requests
cursor-based pagination
in the forward direction, starting after the specified key. - 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() - Method in record class jakarta.data.metamodel.impl.SortableAttributeRecord
- asc() - Method in record class jakarta.data.metamodel.impl.TextAttributeRecord
- asc() - Method in interface jakarta.data.metamodel.SortableAttribute
-
Obtain a request for an ascending
Sort
based on the entity attribute. - asc(String) - Method in interface jakarta.data.page.PageRequest
-
Creates a new page request with the same pagination information, appending the specified
ascending sort
with lower priority than all other sort criteria (if any) that have already been specified. - asc(String) - Static method in record class jakarta.data.Sort
-
Create a
Sort
instance withascending direction
that does not request case insensitive ordering. - ASC - Enum constant in enum class jakarta.data.Direction
-
Ascending direction.
- ascIgnoreCase() - Method in record class jakarta.data.metamodel.impl.TextAttributeRecord
- ascIgnoreCase() - Method in interface jakarta.data.metamodel.TextAttribute
-
Obtain a request for an ascending, case insensitive
Sort
based on the entity attribute. - ascIgnoreCase(String) - Method in interface jakarta.data.page.PageRequest
-
Creates a new page request with the same pagination information, appending the specified
case-insensitive ascending sort
with lower priority than all other sort criteria (if any) that have already been specified. - ascIgnoreCase(String) - Static method in record class jakarta.data.Sort
-
Create a
Sort
instance withascending direction
and case insensitive ordering. - Attribute<T> - Interface in jakarta.data.metamodel
-
Represents an entity attribute in the
StaticMetamodel
. - AttributeRecord<T> - Record Class in jakarta.data.metamodel.impl
-
Record type implementing
TextAttribute
. - AttributeRecord(String) - Constructor for record class jakarta.data.metamodel.impl.AttributeRecord
-
Creates an instance of a
AttributeRecord
record class.
B
- BasicRepository<T,
K> - Interface in jakarta.data.repository -
A built-in repository supertype for performing basic operations on entities.
- beforeCursor(PageRequest.Cursor) - Method in interface jakarta.data.page.PageRequest
-
Requests
cursor-based pagination
in the previous page direction relative to the specified key values. - beforeKey(Object...) - Method in interface jakarta.data.page.PageRequest
-
Requests
cursor-based pagination
in the previous page direction relative to the specified key. - by(Sort<? super T>...) - Static method in class jakarta.data.Order
-
Defines a list of
Sort
criteria, ordered from highest precedence to lowest precedence. - By - Annotation Interface in jakarta.data.repository
-
Annotates a parameter of a repository method, specifying a mapping to a persistent field:
C
- content() - Method in record class jakarta.data.page.impl.CursoredPageRecord
-
Returns the value of the
content
record component. - content() - Method in record class jakarta.data.page.impl.PageRecord
-
Returns the value of the
content
record component. - content() - Method in interface jakarta.data.page.Page
-
Returns the page content as a
List
. - CrudRepository<T,
K> - Interface in jakarta.data.repository -
A built-in repository supertype for performing Create, Read, Update, and Delete (CRUD) operations.
- cursor() - Method in interface jakarta.data.page.PageRequest
-
Returns the key values which are the starting point for cursor-based pagination.
- cursor(int) - Method in interface jakarta.data.page.CursoredPage
-
Returns a
Cursor
for key values at the specified position. - cursor(int) - Method in record class jakarta.data.page.impl.CursoredPageRecord
- CURSOR_NEXT - Enum constant in enum class jakarta.data.page.PageRequest.Mode
-
Indicates forward cursor-based pagination, which follows the direction of the sort criteria, using a cursor that is formed from the key of the last entity on the current page.
- CURSOR_PREVIOUS - Enum constant in enum class jakarta.data.page.PageRequest.Mode
-
Indicates a request for a page with cursor-based pagination in the previous page direction to the sort criteria, using a cursor that is formed from the key of first entity on the current page.
- Cursor-based Pagination with @Query - Search tag in interface jakarta.data.page.CursoredPage
- Section
- CursoredPage<T> - Interface in jakarta.data.page
-
A page of data retrieved to satisfy a given page request, with a cursor for each result on the page.
- CursoredPageRecord<T> - Record Class in jakarta.data.page.impl
-
Record type implementing
CursoredPage
. - CursoredPageRecord(List<T>, List<PageRequest.Cursor>, long, PageRequest<T>, PageRequest<T>, PageRequest<T>) - Constructor for record class jakarta.data.page.impl.CursoredPageRecord
-
Creates an instance of a
CursoredPageRecord
record class. - cursors() - Method in record class jakarta.data.page.impl.CursoredPageRecord
-
Returns the value of the
cursors
record component.
D
- Database Support for Cursor-based Pagination - Search tag in interface jakarta.data.page.CursoredPage
- 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 to use a default data store. - delete(T) - Method in interface jakarta.data.repository.BasicRepository
-
Deletes a given entity.
- Delete - Annotation Interface in jakarta.data.repository
-
Lifecycle annotation for repository methods which perform delete operations; alternatively, annotates a repository method as a parameter-based automatic query method which deletes entities.
- deleteAll(List<? 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.
- desc() - Method in record class jakarta.data.metamodel.impl.SortableAttributeRecord
- desc() - Method in record class jakarta.data.metamodel.impl.TextAttributeRecord
- desc() - Method in interface jakarta.data.metamodel.SortableAttribute
-
Obtain a request for a descending
Sort
based on the entity attribute. - desc(String) - Method in interface jakarta.data.page.PageRequest
-
Creates a new page request with the same pagination information, appending the specified
descending sort
with lower priority than all other sort criteria (if any) that have already been specified. - desc(String) - Static method in record class jakarta.data.Sort
-
Create a
Sort
instance withdescending 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() - Method in record class jakarta.data.metamodel.impl.TextAttributeRecord
- descIgnoreCase() - Method in interface jakarta.data.metamodel.TextAttribute
-
Obtain a request for a descending, case insensitive
Sort
based on the entity attribute. - descIgnoreCase(String) - Method in interface jakarta.data.page.PageRequest
-
Creates a new page request with the same pagination information, appending the specified
case-insensitive descending sort
with lower priority than all other sort criteria (if any) that have already been specified. - descIgnoreCase(String) - Static method in record class jakarta.data.Sort
-
Create a
Sort
instance withdescending direction
and case insensitive ordering. - Direction - Enum Class in jakarta.data
-
Represents the direction of the ordering.
E
- elements() - Method in interface jakarta.data.page.PageRequest.Cursor
-
An unmodifiable list of values in the key.
- 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.
- Entities - Search tag in module jakarta.data
- Section
- 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 record class jakarta.data.metamodel.impl.AttributeRecord
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class jakarta.data.metamodel.impl.SortableAttributeRecord
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class jakarta.data.metamodel.impl.TextAttributeRecord
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class jakarta.data.Order
-
Determines whether this instance specifies matching
Sort
criteria in the same order of precedence as another instance. - equals(Object) - Method in record class jakarta.data.page.impl.CursoredPageRecord
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class jakarta.data.page.impl.PageRecord
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in interface jakarta.data.page.PageRequest.Cursor
-
Returns whether or not the values that make up the key of this cursor are equal to those of the supplied cursor.
- equals(Object) - Method in interface jakarta.data.page.PageRequest
-
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.
F
- Find - Annotation Interface in jakarta.data.repository
-
Annotates a repository method returning entities as a parameter-based automatic query method.
- findAll() - Method in interface jakarta.data.repository.BasicRepository
-
Retrieves all persistent entities of the specified type from the database.
- findAll(PageRequest<T>) - Method in interface jakarta.data.repository.BasicRepository
-
Returns a
Page
of entities according to the page request that is provided as thePageRequest
parameter. - findById(K) - Method in interface jakarta.data.repository.BasicRepository
-
Retrieves an entity by its Id.
- forKey(Object...) - Static method in interface jakarta.data.page.PageRequest.Cursor
-
Obtain an instance of
Cursor
for the given key.
G
- get(int) - Method in interface jakarta.data.page.PageRequest.Cursor
-
Returns the key value at the specified position.
H
- hasContent() - Method in record class jakarta.data.page.impl.CursoredPageRecord
- hasContent() - Method in record class jakarta.data.page.impl.PageRecord
- hasContent() - Method in interface jakarta.data.page.Page
-
Returns whether the
Page
has content at all. - hashCode() - Method in record class jakarta.data.Limit
-
Returns a hash code value for this object.
- hashCode() - Method in record class jakarta.data.metamodel.impl.AttributeRecord
-
Returns a hash code value for this object.
- hashCode() - Method in record class jakarta.data.metamodel.impl.SortableAttributeRecord
-
Returns a hash code value for this object.
- hashCode() - Method in record class jakarta.data.metamodel.impl.TextAttributeRecord
-
Returns a hash code value for this object.
- hashCode() - Method in class jakarta.data.Order
-
Computes a hash code for this instance.
- hashCode() - Method in record class jakarta.data.page.impl.CursoredPageRecord
-
Returns a hash code value for this object.
- hashCode() - Method in record class jakarta.data.page.impl.PageRecord
-
Returns a hash code value for this object.
- hashCode() - Method in interface jakarta.data.page.PageRequest.Cursor
-
Returns a hash code based on the key values.
- hashCode() - Method in record class jakarta.data.Sort
-
Returns a hash code value for this object.
- hasNext() - Method in record class jakarta.data.page.impl.CursoredPageRecord
- hasNext() - Method in record class jakarta.data.page.impl.PageRecord
- hasNext() - Method in interface jakarta.data.page.Page
-
Returns
true
if it is known that there are more results or that it is necessary to request a next page to determine whether there are more results, so thatPage.nextPageRequest()
will definitely not returnnull
. - hasPrevious() - Method in interface jakarta.data.page.CursoredPage
-
Returns
true
when it is possible to navigate to a previous page of results or if it is necessary to request a previous page in order to determine whether there are more previous results. - hasPrevious() - Method in record class jakarta.data.page.impl.CursoredPageRecord
- hasPrevious() - Method in record class jakarta.data.page.impl.PageRecord
- hasPrevious() - Method in interface jakarta.data.page.Page
-
Returns
true
if it is known that there are previous results or that it is necessary to request the previous page to determine whether there are previous results, so thatPage.previousPageRequest()
will not returnnull
. - hasTotals() - Method in record class jakarta.data.page.impl.CursoredPageRecord
- hasTotals() - Method in record class jakarta.data.page.impl.PageRecord
- hasTotals() - Method in interface jakarta.data.page.Page
-
Returns
true
if thePage.pageRequest()
specified that the total number of elements should be retrieved from the database, and that it is therefore safe to callPage.totalElements()
orPage.totalPages()
.
I
- ID - Static variable in annotation interface jakarta.data.repository.By
-
The special value which indicates the unique identifier field or property.
- Identifying a primary entity type: - Search tag in module jakarta.data
- Section
- 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
-
Lifecycle annotation for repository methods which perform insert operations.
- insertAll(List<S>) - Method in interface jakarta.data.repository.CrudRepository
-
Inserts multiple entities into the database.
- 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).
- iterator() - Method in class jakarta.data.Order
-
Returns an iterator that follows the order of precedence for the
Sort
criteria, from highest precedence to lowest. - iterator() - Method in record class jakarta.data.page.impl.CursoredPageRecord
- iterator() - Method in record class jakarta.data.page.impl.PageRecord
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.metamodel - package jakarta.data.metamodel
-
A static metamodel for entities that are used in Jakarta Data repositories.
- jakarta.data.metamodel.impl - package jakarta.data.metamodel.impl
- jakarta.data.page - package jakarta.data.page
-
Splits query results into pages.
- jakarta.data.page.impl - package jakarta.data.page.impl
- jakarta.data.repository - package jakarta.data.repository
-
A repository is an interface annotated with
Repository
that defines operations on entities. - Jakarta Interceptors - 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
- JDQL query methods - Search tag in module jakarta.data
- Section
L
- Lifecycle methods - Search tag in module jakarta.data
- Section
- Limit - Record Class in jakarta.data
-
Specifies a limit on the number of results retrieved by a repository 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 where the entity type is explicitly specified - Search tag in module jakarta.data
- Section
- mode() - Method in interface jakarta.data.page.PageRequest
-
Returns the type of pagination.
- moreResults() - Method in record class jakarta.data.page.impl.PageRecord
-
Returns the value of the
moreResults
record component.
N
- name() - Method in interface jakarta.data.metamodel.Attribute
-
Obtain the entity attribute name, suitable for use wherever the specification requires an entity attribute name.
- name() - Method in record class jakarta.data.metamodel.impl.AttributeRecord
-
Returns the value of the
name
record component. - name() - Method in record class jakarta.data.metamodel.impl.SortableAttributeRecord
-
Returns the value of the
name
record component. - name() - Method in record class jakarta.data.metamodel.impl.TextAttributeRecord
-
Returns the value of the
name
record component. - next() - Method in interface jakarta.data.page.PageRequest
-
Returns the
PageRequest
requesting the next page if using offset pagination. - nextPageRequest() - Method in interface jakarta.data.page.CursoredPage
-
Creates a request for the next page in a forward direction from the current page.
- nextPageRequest() - Method in record class jakarta.data.page.impl.CursoredPageRecord
-
Returns the value of the
nextPageRequest
record component. - nextPageRequest() - Method in record class jakarta.data.page.impl.PageRecord
- nextPageRequest() - Method in interface jakarta.data.page.Page
-
Returns a request for the next page if
Page.hasNext()
indicates there might be a next page. - nextPageRequest(Class<E>) - Method in record class jakarta.data.page.impl.CursoredPageRecord
- nextPageRequest(Class<E>) - Method in record class jakarta.data.page.impl.PageRecord
- nextPageRequest(Class<E>) - Method in interface jakarta.data.page.Page
-
Returns a request for the next page if
Page.hasNext()
indicates there might be a 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 record class jakarta.data.page.impl.CursoredPageRecord
- numberOfElements() - Method in record class jakarta.data.page.impl.PageRecord
- numberOfElements() - Method in interface jakarta.data.page.Page
-
Returns the number of elements on this
Page
, which must be no larger than the maximumsize
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(Class<T>) - Static method in interface jakarta.data.page.PageRequest
-
Creates a page request to use when querying on entities of the specified entity class.
- 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.PageRequest.Mode
-
Indicates a request for a page using offset pagination.
- ofPage(long) - Static method in interface jakarta.data.page.PageRequest
-
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.PageRequest
-
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.
- Order<T> - Class in jakarta.data
-
Requests sorting on various entity attributes.
- 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.PageRequest
-
Returns the page to be returned.
- page(long) - Method in class jakarta.data.Order
-
Create a
PageRequest
for the specified page number of page size 10 (the default forPageRequest
) of the query results sorted according to any static sort criteria that is specified and the ordered list ofSort
criteria that is represented by this instance. - page(long) - Method in interface jakarta.data.page.PageRequest
-
Creates a new page request with the same pagination information, but with the specified page number.
- Page<T> - Interface in jakarta.data.page
-
A page contains the data that is retrieved to satisfy a given page request.
- Page Numbers and Totals - Search tag in interface jakarta.data.page.CursoredPage
- Section
- PageRecord<T> - Record Class in jakarta.data.page.impl
-
Record type implementing
Page
. - PageRecord(PageRequest<T>, List<T>, long) - Constructor for record class jakarta.data.page.impl.PageRecord
-
Constructs a new instance, computing the
PageRecord.moreResults
component astrue
if the pagecontent
is a full page of results and thetotalElements
is either unavailable (indicated by a negative value) or it exceeds the current page number multiplied by thesize
of a full page. - PageRecord(PageRequest<T>, List<T>, long, boolean) - Constructor for record class jakarta.data.page.impl.PageRecord
-
Creates an instance of a
PageRecord
record class. - pageRequest() - Method in record class jakarta.data.page.impl.CursoredPageRecord
-
Returns the value of the
pageRequest
record component. - pageRequest() - Method in record class jakarta.data.page.impl.PageRecord
-
Returns the value of the
pageRequest
record component. - pageRequest() - Method in interface jakarta.data.page.Page
-
Returns the page request for which this page was obtained.
- pageRequest(Class<E>) - Method in record class jakarta.data.page.impl.CursoredPageRecord
- pageRequest(Class<E>) - Method in record class jakarta.data.page.impl.PageRecord
- pageRequest(Class<E>) - Method in interface jakarta.data.page.Page
-
Returns the page request for which this page was obtained.
- PageRequest<T> - Interface in jakarta.data.page
-
A request for a single well-specified page of query results.
- PageRequest.Cursor - Interface in jakarta.data.page
-
A cursor that is formed from a key, relative to which a next or previous page can be requested.
- PageRequest.Mode - Enum Class in jakarta.data.page
-
The type of pagination: offset-based or cursor-based, which includes a direction.
- pageSize(int) - Method in class jakarta.data.Order
-
Create a
PageRequest
for the first page of the specified page size of the query results sorted according to any static sort criteria that is specified and the ordered list ofSort
criteria that is represented by this instance. - 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 automatic query methods - Search tag in module jakarta.data
- Section
- Persistent field names - Search tag in module jakarta.data
- Section
- Persistent field types (basic types) - Search tag in module jakarta.data
- Section
- Precedence of repository methods - Search tag in module jakarta.data
- Section
- previous() - Method in interface jakarta.data.page.PageRequest
-
Returns the
PageRequest
requesting the previous page if using offset pagination, or null if this is the first page, that is, whenPageRequest.page()
returns1
. - previousPageRequest() - Method in interface jakarta.data.page.CursoredPage
-
Creates a request for the previous page in a reverse direction from the current page.
- previousPageRequest() - Method in record class jakarta.data.page.impl.CursoredPageRecord
-
Returns the value of the
previousPageRequest
record component. - previousPageRequest() - Method in record class jakarta.data.page.impl.PageRecord
- previousPageRequest() - Method in interface jakarta.data.page.Page
-
Returns a request for the
previous
page, ifPage.hasPrevious()
indicates there might be a previous page. - previousPageRequest(Class<E>) - Method in record class jakarta.data.page.impl.CursoredPageRecord
- previousPageRequest(Class<E>) - Method in record class jakarta.data.page.impl.PageRecord
- previousPageRequest(Class<E>) - Method in interface jakarta.data.page.Page
-
Returns a request for the previous page, if
Page.hasPrevious()
indicates there might be a previous 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 as a query method, specifying a query written in Jakarta Data Query Language (JDQL) or in Jakarta Persistence Query Language (JPQL).
- 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 theendAt
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
- requestTotal() - Method in interface jakarta.data.page.PageRequest
-
Indicates that a query method which returns a
Page
should retrieve the total number elements available across all pages. - 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 Query by Method Name - 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
-
Lifecycle annotation for repository methods which conditionally perform insert or update operations.
- saveAll(List<S>) - Method in interface jakarta.data.repository.BasicRepository
-
Saves all given entities to the database.
- size() - Method in interface jakarta.data.page.PageRequest.Cursor
-
Returns the number of values in the key.
- size() - Method in interface jakarta.data.page.PageRequest
-
Returns the requested size of each page
- size(int) - Method in interface jakarta.data.page.PageRequest
-
Creates a new page request with the same pagination information, but with the specified maximum page size.
- Sort<T> - 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.
- SortableAttribute<T> - Interface in jakarta.data.metamodel
-
Represents a sortable entity attribute in the
StaticMetamodel
. - SortableAttributeRecord<T> - Record Class in jakarta.data.metamodel.impl
-
Record type implementing
SortableAttribute
. - SortableAttributeRecord(String) - Constructor for record class jakarta.data.metamodel.impl.SortableAttributeRecord
-
Creates an instance of a
SortableAttributeRecord
record class. - sortBy(Sort<? super T>) - Method in interface jakarta.data.page.PageRequest
-
Creates a new page request with the same pagination information, but using the specified sort criteria.
- sortBy(Sort<? super T>, Sort<? super T>) - Method in interface jakarta.data.page.PageRequest
-
Creates a new page request with the same pagination information, but using the specified sort criteria.
- sortBy(Sort<? super T>, Sort<? super T>, Sort<? super T>) - Method in interface jakarta.data.page.PageRequest
-
Creates a new page request with the same pagination information, but using the specified sort criteria.
- sortBy(Sort<? super T>, Sort<? super T>, Sort<? super T>, Sort<? super T>) - Method in interface jakarta.data.page.PageRequest
-
Creates a new page request with the same pagination information, but using the specified sort criteria.
- sortBy(Sort<? super T>, Sort<? super T>, Sort<? super T>, Sort<? super T>, Sort<? super T>) - Method in interface jakarta.data.page.PageRequest
-
Creates a new page request with the same pagination information, but using the specified sort criteria.
- sortBy(Iterable<Sort<? super T>>) - Method in interface jakarta.data.page.PageRequest
-
Creates a new page request with the same pagination information, but using the specified sort criteria.
- Sorting - Search tag in module jakarta.data
- Section
- sorts() - Method in class jakarta.data.Order
-
The instances of
Sort
belonging to thisOrder
. - sorts() - Method in interface jakarta.data.page.PageRequest
-
Return the order collection if it was specified on this page request, otherwise an empty list.
- Special parameters - Search tag in module jakarta.data
- Section
- startAt() - Method in record class jakarta.data.Limit
-
Offset at which to start when returning query results.
- StaticMetamodel - Annotation Interface in jakarta.data.metamodel
-
Annotates a class which serves as a static metamodel for an entity, enabling type-safe access to entity attribute names and related objects such as instances of
Sort
s for an attribute. - stream() - Method in interface jakarta.data.page.Page
-
Returns a sequential stream of results, which follow the order of the sort criteria, if any were specified.
T
- TextAttribute<T> - Interface in jakarta.data.metamodel
-
Represents an textual entity attribute in the
StaticMetamodel
. - TextAttributeRecord<T> - Record Class in jakarta.data.metamodel.impl
-
Record type implementing
TextAttribute
. - TextAttributeRecord(String) - Constructor for record class jakarta.data.metamodel.impl.TextAttributeRecord
-
Creates an instance of a
TextAttributeRecord
record class. - toString() - Method in record class jakarta.data.Limit
-
Returns a string representation of this record class.
- toString() - Method in record class jakarta.data.metamodel.impl.AttributeRecord
-
Returns a string representation of this record class.
- toString() - Method in record class jakarta.data.metamodel.impl.SortableAttributeRecord
-
Returns a string representation of this record class.
- toString() - Method in record class jakarta.data.metamodel.impl.TextAttributeRecord
-
Returns a string representation of this record class.
- toString() - Method in class jakarta.data.Order
-
Textual representation of this instance, including the result of invoking
Sort.toString()
on each member of the sort criteria, in order of precedence from highest to lowest. - toString() - Method in record class jakarta.data.page.impl.CursoredPageRecord
-
Returns a string representation of this record class.
- toString() - Method in record class jakarta.data.page.impl.PageRecord
-
Returns a string representation of this record class.
- toString() - Method in interface jakarta.data.page.PageRequest.Cursor
-
String representation of the 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 record class jakarta.data.page.impl.CursoredPageRecord
-
Returns the value of the
totalElements
record component. - totalElements() - Method in record class jakarta.data.page.impl.PageRecord
-
Returns the value of the
totalElements
record component. - totalElements() - Method in interface jakarta.data.page.Page
-
Returns the total number of elements across all pages of query results, if the
Page.pageRequest()
specified that the total should be retrieved from the database. - totalPages() - Method in record class jakarta.data.page.impl.CursoredPageRecord
- totalPages() - Method in record class jakarta.data.page.impl.PageRecord
- totalPages() - Method in interface jakarta.data.page.Page
-
Returns the total number of pages of query results, if the
Page.pageRequest()
specified that the total should be retrieved from the database.
U
- update(S) - Method in interface jakarta.data.repository.CrudRepository
-
Modifies an entity that already exists in the database.
- Update - Annotation Interface in jakarta.data.repository
-
Lifecycle annotation for repository methods which perform update operations.
- updateAll(List<S>) - Method in interface jakarta.data.repository.CrudRepository
-
Modifies entities that already exist in the database.
V
- value() - Element in annotation interface jakarta.data.metamodel.StaticMetamodel
-
An entity class.
- value() - Element in annotation interface jakarta.data.repository.By
-
The name of the persistent field mapped by the annotated parameter, or "#id" to indicate the unique identifier field or property of the entity.
- 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
-
Specifies the query executed by the annotated repository method, in JDQL or JPQL.
- 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.PageRequest.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.PageRequest.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
- withoutTotal() - Method in interface jakarta.data.page.PageRequest
-
Returns an otherwise-equivalent page request with
PageRequest.requestTotal()
set tofalse
, so that totals will not be retrieved from the database. - withTotal() - Method in interface jakarta.data.page.PageRequest
-
Returns an otherwise-equivalent page request with
PageRequest.requestTotal()
set tofalse
, so that totals will be retrieved from the database.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form