Skip to content

Commit 68abe5a

Browse files
committed
proofread the Short Guide
Signed-off-by: Gavin King <[email protected]>
1 parent 019cbf5 commit 68abe5a

File tree

5 files changed

+12
-12
lines changed

5 files changed

+12
-12
lines changed

documentation/src/main/asciidoc/introduction/Advanced.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -466,7 +466,7 @@ Furthermore, the link:{doc-javadoc-url}org/hibernate/annotations/ValueGeneration
466466
[NOTE]
467467
// .The older APIs are still available in Hibernate 6
468468
====
469-
These APIs are new in Hibernate 6, and supersede the classic `IdentifierGenerator` interface and `@GenericGenerator` annotation from older versions of Hibernate.
469+
These APIs were new in Hibernate 6, and supersede the classic `IdentifierGenerator` interface and `@GenericGenerator` annotation from older versions of Hibernate.
470470
However, the older APIs are still available and custom ``IdentifierGenerator``s written for older versions of Hibernate continue to work in Hibernate 6.
471471
====
472472

documentation/src/main/asciidoc/introduction/Configuration.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ First, add the following dependency to your project:
5454
org.hibernate.orm:hibernate-core:{version}
5555
----
5656

57-
Where `{version}` is the version of Hibernate you're using.
57+
Where `{version}` is the version of Hibernate you're using, `{fullVersion}`, for example.
5858

5959
You'll also need to add a dependency for the JDBC
6060
driver for your database.
@@ -307,7 +307,7 @@ The properties you really do need to get started are these three:
307307
[IMPORTANT]
308308
// .You don't need `hibernate.dialect` anymore!
309309
====
310-
In Hibernate 6, you don't need to specify `hibernate.dialect`.
310+
Since Hibernate 6, you don't need to specify `hibernate.dialect`.
311311
The correct Hibernate SQL `Dialect` will be determined for you automatically.
312312
The only reason to specify this property is if you're using a custom user-written `Dialect` class.
313313
@@ -509,7 +509,7 @@ So, if you're working with SQL Server, you might need to force Hibernate to use
509509
| `hibernate.use_nationalized_character_data` | Use `nchar` and `nvarchar` instead of `char` and `varchar`
510510
|===
511511

512-
On the other hand, if only _some_ columns store nationalized data, use the `@Nationalized` annotation to indicate fields of your entities which map these columns.
512+
On the other hand, if only _some_ columns store nationalized data, use the link:{doc-javadoc-url}org/hibernate/annotations/Nationalized.html[`@Nationalized`] annotation to indicate fields of your entities which map these columns.
513513

514514
[TIP]
515515
// .Configuring SQL Server to use UTF-8 by default

documentation/src/main/asciidoc/introduction/Entities.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -549,7 +549,7 @@ Hibernate slightly extends this list with the following types:
549549
| Additional date/time types | `java.time` | `Duration`, `ZoneId`, `ZoneOffset`, and even `ZonedDateTime`
550550
| JDBC LOB types | `java.sql` | `Blob`, `Clob`, `NClob`
551551
| Java class object | `java.lang` | `Class`
552-
| Miscellaneous types | `java.util` | `Currency`, `URL`, `TimeZone`
552+
| Miscellaneous types | `java.util` | `Currency`, `Locale`, `URL`, `TimeZone`
553553
|====
554554

555555
The `@Basic` annotation explicitly specifies that an attribute is basic, but it's often not needed, since attributes are assumed basic by default.
@@ -807,7 +807,7 @@ The types defined by the JDBC specification are enumerated by the integer type c
807807
Each JDBC type is an abstraction of a commonly-available type in SQL.
808808
For example, `Types.VARCHAR` represents the SQL type `VARCHAR` (or `VARCHAR2` on Oracle).
809809
810-
Since Hibernate understands more SQL types than JDBC, there's an extended list of integer type codes in the class `org.hibernate.type.SqlTypes`.
810+
Since Hibernate understands more SQL types than JDBC, there's an extended list of integer type codes in the class link:{doc-javadoc-url}org/hibernate/type/SqlTypes.html[`org.hibernate.type.SqlTypes`].
811811
For example, `SqlTypes.GEOMETRY` represents the spatial data type `GEOMETRY`.
812812
****
813813

documentation/src/main/asciidoc/introduction/Interacting.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -799,7 +799,7 @@ Of course, we could construct a HQL query by string concatenation, but this is a
799799

800800
.HQL is implemented in terms of criteria objects
801801
****
802-
Actually, in Hibernate 6, every HQL query is compiled to a criteria query before being translated to SQL.
802+
Actually, since Hibernate 6, every HQL query is compiled to a criteria query before being translated to SQL.
803803
This ensures that the semantics of HQL and criteria queries are identical.
804804
****
805805

documentation/src/main/asciidoc/introduction/Introduction.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ For example:
9090
| `org.hibernate.Cache` | `javax.persistence.Cache`
9191
| `@org.hibernate.annotations.NamedQuery` | `@javax.persistence.NamedQuery`
9292
| `@org.hibernate.annotations.Cache` | `@javax.persistence.Cacheable`
93+
| `org.hibernate.relational.SchemaManager` | `jakarta.persistence.SchemaManager`
9394
|===
9495

9596
Typically, the Hibernate-native APIs offer something a little extra that's missing in JPA, so this isn't exactly a _flaw_.
@@ -103,7 +104,7 @@ If you're completely new to Hibernate and JPA, you might already be wondering ho
103104
Well, typically, our persistence-related code comes in two layers:
104105

105106
. a representation of our data model in Java, which takes the form of a set of annotated entity classes, and
106-
. a larger number of functions which interact with Hibernate's APIs to perform the persistence operations associated with your various transactions.
107+
. a larger number of functions which interact with Hibernate's APIs to perform the persistence operations associated with our various transactions.
107108

108109
The first part, the data or "domain" model, is usually easier to write, but doing a great and very clean job of it will strongly affect your success in the second part.
109110

@@ -157,15 +158,15 @@ dependencies {
157158
implementation 'org.hibernate.orm:hibernate-core:{fullVersion}'
158159
159160
// Hibernate Validator
160-
implementation 'org.hibernate.validator:hibernate-validator:8.0.0.Final'
161+
implementation 'org.hibernate.validator:hibernate-validator:8.0.1.Final'
161162
implementation 'org.glassfish:jakarta.el:4.0.2'
162163
163164
// Agroal connection pool
164165
implementation 'org.hibernate.orm:hibernate-agroal:{fullVersion}'
165166
implementation 'io.agroal:agroal-pool:2.1'
166167
167168
// logging via Log4j
168-
implementation 'org.apache.logging.log4j:log4j-core:2.20.0'
169+
implementation 'org.apache.logging.log4j:log4j-core:2.24.1'
169170
170171
// Hibernate Processor
171172
annotationProcessor 'org.hibernate.orm:hibernate-processor:{fullVersion}'
@@ -175,7 +176,7 @@ dependencies {
175176
//annotationProcessor 'org.hibernate:query-validator:2.0-SNAPSHOT'
176177
177178
// H2 database
178-
runtimeOnly 'com.h2database:h2:2.1.214'
179+
runtimeOnly 'com.h2database:h2:2.3.232'
179180
}
180181
----
181182

@@ -790,7 +791,6 @@ This "test" is one which many people like to run even in production, when the sy
790791

791792
It's now time to begin our journey toward actually _understanding_ the code we saw earlier.
792793

793-
This introduction will guide you through the basic tasks involved in developing a program that uses Hibernate for persistence:
794794
This introduction will guide you through the basic tasks involved in developing a program that uses Hibernate for persistence:
795795

796796
1. configuring and bootstrapping Hibernate, and obtaining an instance of `SessionFactory` or `EntityManagerFactory`,

0 commit comments

Comments
 (0)