Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix some javadoc

This commit is contained in:
Gavin 2023-04-29 00:15:03 +02:00
parent c36fdc4d06
commit aa9bb26498
1 changed files with 30 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
hibernate-core/src/main/java/org/hibernate/metamodel/mapping/Bindable.java
View File

@ -52,43 +52,45 @@ public interface Bindable extends JdbcMappingContainer {
}
/**
* @asciidoc Breaks down a value of `J` into its simple pieces. E.g., an embedded
* Breaks down a value of {@code J} into its simple pieces. E.g., an embedded
* value gets broken down into an array of its attribute state; a basic
* value converts to itself; etc.
* <p>
* Generally speaking, this is the form in which entity state is kept relative to a
* Session via `EntityEntry`.
* @Entity class Person {
* @Id Integer id;
* @Embedded Name name;
* Session via {@code EntityEntry}.
* <p>
* <pre>
* &#64;Entity class Person {
* &#64;Id Integer id;
* &#64;Embedded Name name;
* int age;
* }
* @Embeddable class Name {
*
* &#64;Embeddable class Name {
* String familiarName;
* String familyName;
* }
* ````
* </pre>
* <p>
* At the top-level, we would want to disassemble a `Person` value so we'd ask the
* `Bindable` for the `Person` entity to disassemble. Given a Person value:
* At the top level, we would want to disassemble a {@code Person} value, so we'd
* ask the {@code Bindable} for the {@code Person} entity to disassemble. Given a
* {@code Person} value:
* <p>
* ````
* <pre>
* Person( id=1, name=Name( 'Steve', 'Ebersole' ), 28 )
* ````
* </pre>
* <p>
* this disassemble would result in a multi-dimensional array:
* this disassemble would result in a multidimensional array:
* <p>
* ````
* <pre>
* [ ["Steve", "Ebersole"], 28 ]
* ````
* </pre>
* <p>
* Note that the identifier is not part of this disassembled state. Note also
* how the embedded value results in a sub-array.
*
* @see org.hibernate.engine.spi.EntityEntry
* <p>
* As an example, consider the following domain model:
* <p>
* ````
*/
Object disassemble(Object value, SharedSessionContractImplementor session);
@ -103,20 +105,18 @@ public interface Bindable extends JdbcMappingContainer {
void addToCacheKey(MutableCacheKeyBuilder cacheKey, Object value, SharedSessionContractImplementor session);
/**
* @asciidoc
*
* Visit each constituent JDBC value over the result from {@link #disassemble}.
*
* <p>
* Given the example in {@link #disassemble}, this results in the consumer being
* called for each simple value. E.g.:
*
* ````
* <p>
* <pre>
* consumer.consume( "Steve" );
* consumer.consume( "Ebersole" );
* consumer.consume( 28 );
* ````
*
* Think of it as breaking the multi-dimensional array into a visitable flat array.
* </pre>
* <p>
* Think of it as breaking the multidimensional array into a visitable flat array.
* Additionally, it passes through the values {@code X} and {@code Y} to the consumer.
*/
default <X, Y> int forEachDisassembledJdbcValue(