-
Notifications
You must be signed in to change notification settings - Fork 59
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
move verbose API definitions to appendices (#604)
* move API definitions to appendices * try to improve flow * tidy up xrefs * further improvements to xrefs
- Loading branch information
Showing
12 changed files
with
626 additions
and
9,808 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| [appendix] | ||
| == Persistence API Interfaces [[persistence-api]] | ||
|
|
||
| The following APIs are defined in the package `jakarta.persistence`. | ||
|
|
||
| === `EntityManager` [[_entitymanager_]] | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/EntityManager.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `EntityTransaction` [[_entitytransaction_]] | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/EntityTransaction.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `EntityManagerFactory` [[_entitymanagerfactory_]] | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/EntityManagerFactory.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `LockModeType` [[_lockmodetype_]] | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/LockModeType.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `Cache` [[_cache_]] | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/Cache.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `Query` [[_query_]] | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/Query.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `TypedQuery` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/TypedQuery.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `StoredProcedureQuery` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/StoredProcedureQuery.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `Tuple` [[_tuple_]] | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/Tuple.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `TupleElement` [[_tupleelement_]] | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/TupleElement.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `Parameter` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/Parameter.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `Graph` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/Graph.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `EntityGraph` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/EntityGraph.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `Subgraph` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/Subgraph.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `AttributeNode` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/AttributeNode.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `SchemaManager` [[_schemamanager_]] | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/SchemaManager.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `Persistence` [[_persistence_]] | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/Persistence.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `PersistenceConfiguration` [[_persistenceconfiguration_]] | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/PersistenceConfiguration.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `PersistenceUtil` [[_persistenceutil_]] | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/PersistenceUtil.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `PersistenceUnitUtil` [[_persistenceunitutil_]] | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/PersistenceUnitUtil.java[lines=18..-1] | ||
| ---- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,190 @@ | ||
| [appendix] | ||
| == Criteria API Interfaces [[criteria-api]] | ||
|
|
||
| The following APIs are defined in the package `jakarta.persistence.criteria`. | ||
|
|
||
| === `CriteriaBuilder` [[_criteriabuilder_]] | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/CriteriaBuilder.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `CriteriaDelete` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/CriteriaDelete.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `CriteriaQuery` [[_criteriaquery_]] | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/CriteriaQuery.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `CriteriaSelect` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/CriteriaSelect.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `CriteriaUpdate` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/CriteriaUpdate.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `AbstractQuery` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/AbstractQuery.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `CollectionJoin` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/CollectionJoin.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `CommonAbstractCriteria` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/CommonAbstractCriteria.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `CompoundSelection` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/CompoundSelection.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `Expression` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/Expression.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `Fetch` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/Fetch.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `FetchParent` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/FetchParent.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `AbstractQuery` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/From.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `Join` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/Join.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `JoinType` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/JoinType.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `ListJoin` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/ListJoin.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `LocalDateField` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/LocalDateField.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `LocalDateTimeField` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/LocalDateTimeField.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `LocalTimeField` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/LocalTimeField.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `MapJoin` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/MapJoin.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `Nulls` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/Nulls.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `Order` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/Order.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `ParameterExpression` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/ParameterExpression.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `Path` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/Path.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `PluralJoin` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/PluralJoin.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `Predicate` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/Predicate.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `Root` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/Root.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `Selection` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/Selection.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `SetJoin` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/SetJoin.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `Subquery` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/Subquery.java[lines=18..-1] | ||
| ---- | ||
|
|
||
| === `TemporalField` | ||
| [source,java] | ||
| ---- | ||
| include::../../../../api/src/main/java/jakarta/persistence/criteria/TemporalField.java[lines=18..-1] | ||
| ---- |
Oops, something went wrong.