Index (Jakarta Data API 1.0.0-M1 API)

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

A

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() - Method in class jakarta.data.model.Attribute: Obtain a request for an ascending Sort based on the entity attribute.
asc() - Method in interface jakarta.data.model.AttributeInfo: Returns a request for an ascending Sort based on the entity attribute.
asc(String) - Static method in record class jakarta.data.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.Direction: Ascending direction.
ascIgnoreCase() - Method in class jakarta.data.model.Attribute: Obtain a request for an ascending, case insensitive Sort based on the entity attribute.
ascIgnoreCase() - Method in interface jakarta.data.model.AttributeInfo: Returns a request for an ascending, case insensitive Sort based on the entity attribute.
ascIgnoreCase(String) - Static method in record class jakarta.data.Sort: Create a Sort instance with ascending direction Direction.ASC and case insensitive ordering.
Attribute - Class in jakarta.data.model: Represents an entity attribute in the StaticMetamodel.
AttributeInfo - Interface in jakarta.data.model: Implemented by the Jakarta Data provider to initialize an attribute field in the StaticMetamodel.

B

BasicRepository<T,K> - Interface in jakarta.data.repository: A repository interface 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.

C

content() - Method in interface jakarta.data.page.Slice: Returns the page content as 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 repository interface that extends the capabilities of basic operations on entities, including insert and update operations.
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 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.page.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.BasicRepository: Deletes a given entity.
Delete - Annotation Interface in jakarta.data.repository: The Delete annotation indicates that the annotated repository method requests one or more entities to be removed from the database.
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() - Method in class jakarta.data.model.Attribute: Obtain a request for a descending Sort based on the entity attribute.
desc() - Method in interface jakarta.data.model.AttributeInfo: Returns a request for a descending Sort based on the entity attribute.
desc(String) - Static method in record class jakarta.data.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.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 class jakarta.data.model.Attribute: Obtain a request for a descending, case insensitive Sort based on the entity attribute.
descIgnoreCase() - Method in interface jakarta.data.model.AttributeInfo: Returns a request for a descending, case insensitive Sort based on the entity attribute.
descIgnoreCase(String) - Static method in record class jakarta.data.Sort: Create a Sort instance with descending direction Direction.DESC and case insensitive ordering.
Direction - Enum Class in jakarta.data: 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.
EntityExistsException - Exception 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 jakarta.data.exceptions.EntityExistsException: Constructs a new EntityExistsException with the specified detail message.
EntityExistsException(String, Throwable) - Constructor for exception jakarta.data.exceptions.EntityExistsException: Constructs a new EntityExistsException with the specified detail message and cause.
EntityExistsException(Throwable) - Constructor for exception 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 instance are equal to those of the supplied instance.
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 meeting the paging restriction provided in the Pageable object.
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

get() - Static method in class jakarta.data.model.Attribute: Obtains a new instance for the Jakarta Data provider to initialize.
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

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.
init(AttributeInfo) - Method in class jakarta.data.model.Attribute: Used by the Jakarta Data provider to initialize this Attribute with implementation.
insert(S) - Method in interface jakarta.data.repository.CrudRepository: Inserts an entity into the database.
Insert - Annotation Interface in jakarta.data.repository: The Insert annotation indicates that the annotated repository method requests that one or more entities be inserted into the database.
insertAll(Iterable<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).

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 makes data access easy.
jakarta.data.exceptions - package jakarta.data.exceptions: Common data access exceptions.
jakarta.data.model - package jakarta.data.model: A static metamodel for entities that are used in Jakarta Data repositories.
jakarta.data.page - package jakarta.data.page: Splits query results into slices or pages.
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.page: A page of results from a repository query that performs keyset pagination.
KeysetAwareSlice<T> - Interface in jakarta.data.page: 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: 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.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.Limit: Maximum number of results that can be returned for a single invocation of the repository method.
mode() - Method in interface jakarta.data.page.Pageable: Returns the type of pagination.

N

name() - Method in class jakarta.data.model.Attribute: Obtain the entity attribute name, suitable for use wherever the specification requires an entity attribute name.
name() - Method in interface jakarta.data.model.AttributeInfo: Returns the name of the entity attribute, suitable for use wherever the specification requires an entity attribute name.
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: Returns pagination information for requesting the next page in a forward direction from the current page.
nextPageable() - Method in interface jakarta.data.page.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.page.Slice: Returns the number of elements currently on this Slice.

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 Pageable 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 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.page.Pageable: Returns the page to be returned.
page(long) - Method in interface jakarta.data.page.Pageable: Creates a new Pageable instance representing the same pagination information, except with the specified page number.
Page<T> - Interface in jakarta.data.page: A page is a sublist of results.
pageable() - Method in interface jakarta.data.page.Slice: Returns the current Pageable
Pageable - Interface in jakarta.data.page: This class represents pagination information.
Pageable.Cursor - Interface in jakarta.data.page: Represents keyset values, which can be a starting point for requesting a next or previous page.
Pageable.Mode - Enum Class in jakarta.data.page: 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.page.KeysetAwareSlice: Returns pagination information for requesting 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: Defines the query string such as SQL, JPA-QL, Cypher etc.

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 data repository interface that will be implemented by the container/runtime.

S

save(S) - Method in interface jakarta.data.repository.BasicRepository: Saves a given entity to the database.
Save - Annotation Interface in jakarta.data.repository: The Save annotation indicates that the annotated repository method updates one or more 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 Pageable instance representing the same pagination information, except with the specified maximum page size.
Slice<T> - Interface in jakarta.data.page: A slice of data that indicates whether there's a next or previous slice available.
Sort - Record Class in jakarta.data: 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.Sort: Defines sort criteria for an entity property.
sortBy(Sort...) - Method in interface jakarta.data.page.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.page.Pageable: Creates a new Pageable instance representing the same pagination information, except using the specified sort criteria.
sorts() - Method in interface jakarta.data.page.Pageable: Return the order collection if it was specified on this Pageable, otherwise an empty list.
startAt() - Method in record class jakarta.data.Limit: Offset at which to start when returning query results.
StaticMetamodel - Annotation Interface in jakarta.data.model: Annotates a class to serve as a static metamodel for an entity, enabling type-safe access to entity attribute names and related objects, such as Sorts for an attribute.
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: Simple interface to ease streamability of Iterables.

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 amount of elements.
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: The Update annotation indicates that the annotated repository method requests that one or more entities be updated if found in the database.
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.model.StaticMetamodel: An entity class.
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.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.

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