Skip to content

Commit aa9bb26

Browse files
committed
fix some javadoc
1 parent c36fdc4 commit aa9bb26

File tree

1 file changed

+28
-28
lines changed
  • hibernate-core/src/main/java/org/hibernate/metamodel/mapping

1 file changed

+28
-28
lines changed

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

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -52,43 +52,45 @@ default int forEachJdbcType(IndexedConsumer<JdbcMapping> action) {
5252
}
5353

5454
/**
55-
* @asciidoc Breaks down a value of `J` into its simple pieces. E.g., an embedded
55+
* Breaks down a value of {@code J} into its simple pieces. E.g., an embedded
5656
* value gets broken down into an array of its attribute state; a basic
5757
* value converts to itself; etc.
5858
* <p>
5959
* Generally speaking, this is the form in which entity state is kept relative to a
60-
* Session via `EntityEntry`.
61-
* @Entity class Person {
62-
* @Id Integer id;
63-
* @Embedded Name name;
64-
* int age;
60+
* Session via {@code EntityEntry}.
61+
* <p>
62+
* <pre>
63+
* &#64;Entity class Person {
64+
* &#64;Id Integer id;
65+
* &#64;Embedded Name name;
66+
* int age;
6567
* }
66-
* @Embeddable class Name {
67-
* String familiarName;
68-
* String familyName;
68+
*
69+
* &#64;Embeddable class Name {
70+
* String familiarName;
71+
* String familyName;
6972
* }
70-
* ````
73+
* </pre>
7174
* <p>
72-
* At the top-level, we would want to disassemble a `Person` value so we'd ask the
73-
* `Bindable` for the `Person` entity to disassemble. Given a Person value:
75+
* At the top level, we would want to disassemble a {@code Person} value, so we'd
76+
* ask the {@code Bindable} for the {@code Person} entity to disassemble. Given a
77+
* {@code Person} value:
7478
* <p>
75-
* ````
79+
* <pre>
7680
* Person( id=1, name=Name( 'Steve', 'Ebersole' ), 28 )
77-
* ````
81+
* </pre>
7882
* <p>
79-
* this disassemble would result in a multi-dimensional array:
83+
* this disassemble would result in a multidimensional array:
8084
* <p>
81-
* ````
85+
* <pre>
8286
* [ ["Steve", "Ebersole"], 28 ]
83-
* ````
87+
* </pre>
8488
* <p>
8589
* Note that the identifier is not part of this disassembled state. Note also
8690
* how the embedded value results in a sub-array.
91+
*
8792
* @see org.hibernate.engine.spi.EntityEntry
8893
* <p>
89-
* As an example, consider the following domain model:
90-
* <p>
91-
* ````
9294
*/
9395
Object disassemble(Object value, SharedSessionContractImplementor session);
9496

@@ -103,20 +105,18 @@ default int forEachJdbcType(IndexedConsumer<JdbcMapping> action) {
103105
void addToCacheKey(MutableCacheKeyBuilder cacheKey, Object value, SharedSessionContractImplementor session);
104106

105107
/**
106-
* @asciidoc
107-
*
108108
* Visit each constituent JDBC value over the result from {@link #disassemble}.
109-
*
109+
* <p>
110110
* Given the example in {@link #disassemble}, this results in the consumer being
111111
* called for each simple value. E.g.:
112-
*
113-
* ````
112+
* <p>
113+
* <pre>
114114
* consumer.consume( "Steve" );
115115
* consumer.consume( "Ebersole" );
116116
* consumer.consume( 28 );
117-
* ````
118-
*
119-
* Think of it as breaking the multi-dimensional array into a visitable flat array.
117+
* </pre>
118+
* <p>
119+
* Think of it as breaking the multidimensional array into a visitable flat array.
120120
* Additionally, it passes through the values {@code X} and {@code Y} to the consumer.
121121
*/
122122
default <X, Y> int forEachDisassembledJdbcValue(

0 commit comments

Comments
 (0)