From a2d45a26794c0dc357c34aa9b545e17bdeb213d2 Mon Sep 17 00:00:00 2001 From: Steve Ebersole Date: Tue, 29 Aug 2023 13:19:06 -0500 Subject: [PATCH] HHH-16962 - General documentation improvements HHH-17141 - Prepare for 6.3.0 release https://hibernate.atlassian.net/browse/HHH-16962 https://hibernate.atlassian.net/browse/HHH-17141 --- documentation/documentation.gradle | 56 +- gradle/java-module.gradle | 25 +- gradle/javadoc.gradle | 31 +- gradle/libraries.gradle | 16 - hibernate-core/hibernate-core.gradle | 5 +- .../src/main/javadoc/images/bkg_blkheader.png | Bin 2835 -> 0 bytes .../src/main/javadoc/images/bkg_gradient.gif | Bin 719 -> 0 bytes .../src/main/javadoc/images/bkgheader.png | Bin 270 -> 0 bytes .../src/main/javadoc/images/h1_hdr.png | Bin 13173 -> 0 bytes hibernate-core/src/main/javadoc/overview.html | 257 ----- .../src/main/javadoc/stylesheet.css | 948 ------------------ .../src/main => shared}/javadoc/overview.html | 0 .../main => shared}/javadoc/stylesheet.css | 0 .../hibernate-gradle-plugin.gradle | 7 + 14 files changed, 58 insertions(+), 1287 deletions(-) delete mode 100644 gradle/libraries.gradle delete mode 100644 hibernate-core/src/main/javadoc/images/bkg_blkheader.png delete mode 100644 hibernate-core/src/main/javadoc/images/bkg_gradient.gif delete mode 100644 hibernate-core/src/main/javadoc/images/bkgheader.png delete mode 100644 hibernate-core/src/main/javadoc/images/h1_hdr.png delete mode 100644 hibernate-core/src/main/javadoc/overview.html delete mode 100644 hibernate-core/src/main/javadoc/stylesheet.css rename {documentation/src/main => shared}/javadoc/overview.html (100%) rename {documentation/src/main => shared}/javadoc/stylesheet.css (100%) diff --git a/documentation/documentation.gradle b/documentation/documentation.gradle index c87e3243a5..b332e04da4 100644 --- a/documentation/documentation.gradle +++ b/documentation/documentation.gradle @@ -190,68 +190,33 @@ else { // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -// aggregated JavaDoc +// aggregated Javadoc // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -def aggregateJavadocsTask = tasks.register( "aggregateJavadocs", Javadoc ) { +def aggregateJavadocsTask = tasks.register( "javadoc", Javadoc ) { group = "documentation" - description = 'Builds an aggregated JavaDoc across all ORM sub-projects' - - inputs.property "ormVersion", project.ormVersion + description = 'Builds JavaDoc aggregated across all ORM sub-projects' destinationDir = mkdir( layout.buildDirectory.file( 'javadocs' ) ) source = configurations.javadocSources classpath = configurations.javadocClasspath - // exclude any generated sources and internal packages - exclude '**/generated-src/**' - exclude '**/internal/**' - include '**/*.java' - - maxMemory = '512m' - - final int currentYear = new GregorianCalendar().get( Calendar.YEAR ) - configure( options ) { - overview = 'src/main/javadoc/overview.html' - stylesheetFile = project.file( 'src/main/javadoc/stylesheet.css' ) + overview = rootProject.file( "shared/javadoc/overview.html" ) windowTitle = 'Hibernate Javadocs' docTitle = "Hibernate Javadoc ($project.version)" - bottom = "Copyright © 2001-$currentYear Red Hat, Inc. All Rights Reserved." - use = true - encoding = 'UTF-8' + } - tags( - 'todo:X', - 'apiNote:a:API Note:', - 'implSpec:a:Implementation Specification:', - 'implNote:a:Implementation Note:', - 'settingDefault:f:Default Value:' - ) - - links = [ - 'https://docs.oracle.com/en/java/javase/11/docs/api/', - 'https://jakarta.ee/specifications/bean-validation/3.0/apidocs/', - 'https://jakarta.ee/specifications/cdi/4.0/apidocs/', - 'https://jakarta.ee/specifications/platform/9/apidocs/', - 'https://www.javadoc.io/doc/javax.cache/cache-api/1.0.0/' - ] - - addStringOption( 'Xdoclint:none', '-quiet' ) -// -// if ( jdkVersions.explicit ) { + if ( jdkVersions.explicit ) { // setJFlags( // getProperty( 'toolchain.javadoc.jvmargs' ).toString(). // split( ' ' ).toList().findAll( { !it.isEmpty() } ) // ) -// } - } - if ( jdkVersions.explicit ) { // Display version of Java tools doFirst { if ( javadocTool.present ) { - logger.lifecycle "Aggregating javadoc with '${javadocTool.get().metadata.installationPath}'" + logger.lifecycle "Building aggregated javadoc with '${javadocTool.get().metadata.installationPath}'" } } } @@ -262,13 +227,16 @@ def aggregateJavadocsTask = tasks.register( "aggregateJavadocs", Javadoc ) { : JavaLanguageVersion.of( JavaVersion.current().name ) if ( javaLanguageVersion.asInt() > 11 ) { - println "`aggregateJavadocs` is being run with a JDK newer than version 11: \n" + + println "Aggregated Javadocs are bing built` using a JDK newer than version 11: \n" + "\t* `stylesheet.css` will not be compatible\n" + "\t* generating the User Guide settings fragment will not succeed" } } } +apply from: rootProject.file( 'gradle/javadoc.gradle' ) + + asciidoctorj { requires 'rouge' modules { @@ -601,7 +569,7 @@ def generateSettingsDocTask = tasks.named( "generateSettingsDoc" ) { : JavaLanguageVersion.of( JavaVersion.current().name ) if ( javaLanguageVersion.asInt() > 11 ) { - println "`aggregateJavadocs` was run with a JDK newer than version 11; generating the settings User Guide fragment will not succeed" + println "Aggregated Javadocs was built using a JDK newer than version 11; generating the settings User Guide fragment will not succeed" } } } diff --git a/gradle/java-module.gradle b/gradle/java-module.gradle index b6321399c0..263f2ac1ab 100644 --- a/gradle/java-module.gradle +++ b/gradle/java-module.gradle @@ -21,11 +21,12 @@ buildscript { import de.thetaphi.forbiddenapis.gradle.CheckForbiddenApis import org.apache.tools.ant.filters.ReplaceTokens -apply from: rootProject.file( 'gradle/module.gradle' ) -apply from: rootProject.file( 'gradle/libraries.gradle' ) -apply from: rootProject.file( 'gradle/databases.gradle' ) - apply plugin: 'java-library' + +apply from: rootProject.file( 'gradle/module.gradle' ) +apply from: rootProject.file( 'gradle/databases.gradle' ) +apply from: rootProject.file( 'gradle/javadoc.gradle' ) + apply plugin: 'biz.aQute.bnd.builder' apply plugin: 'org.hibernate.orm.database-service' apply plugin: 'org.hibernate.orm.build.java-module' @@ -58,6 +59,15 @@ if ( !project.description ) { // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // Configurations and Dependencies +configurations.configureEach { + resolutionStrategy.eachDependency { details -> + //Force the "byte buddy agent" version to match the Byte Buddy version + // we use, as Mockito might pull in a mismatched version transitively + if (details.requested.group == "net.bytebuddy" && details.requested.name == 'byte-buddy-agent') { + details.useVersion libs.versions.byteBuddy.get() + } + } +} dependencies { implementation libs.logging @@ -383,7 +393,12 @@ task sourcesJar(type: Jar) { // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // Javadoc -apply from: rootProject.file( 'gradle/javadoc.gradle' ) +tasks.named( "javadoc", Javadoc ) { + configure( options ) { + windowTitle = "Hibernate Javadocs ($project.name)" + docTitle = "Hibernate Javadocs ($project.name : $project.version)" + } +} // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // IDE diff --git a/gradle/javadoc.gradle b/gradle/javadoc.gradle index 466e480a98..112dae192a 100644 --- a/gradle/javadoc.gradle +++ b/gradle/javadoc.gradle @@ -5,16 +5,20 @@ * See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html */ -// make sure Java plugin is applied -apply plugin : 'java' - apply from: rootProject.file( 'gradle/base-information.gradle' ) -javadoc { - exclude( "**/internal/*" ) - exclude( "**/generated-src/**" ) +tasks.named( "javadoc", Javadoc ) { + def currentYear = new GregorianCalendar().get( Calendar.YEAR ) - final int currentYear = new GregorianCalendar().get( Calendar.YEAR ) + inputs.property "ormVersion", project.ormVersion + inputs.property "currentYear", currentYear + + // exclude any generated sources and internal packages + exclude '**/generated-src/**' + exclude '**/internal/**' + include '**/*.java' + + maxMemory = '512m' configure( options ) { // this is the config needed to use asciidoclet for Javadoc rendering. It relies on a build from John's PR @ https://github.com/asciidoctor/asciidoclet/pull/91 @@ -25,14 +29,13 @@ javadoc { // Travis CI JDK 11 build did not like this // docletpath = configurations.asciidoclet.files.asType(List) // doclet = 'org.asciidoctor.Asciidoclet' - overview = 'src/main/javadoc/overview.html' - stylesheetFile = project.file( 'src/main/javadoc/stylesheet.css' ) - windowTitle = "$project.name JavaDocs" - docTitle = "$project.name JavaDocs ($project.version)" - bottom = "Copyright © 2001-$currentYear Red Hat, Inc. All Rights Reserved." + use = true encoding = 'UTF-8' + stylesheetFile = rootProject.file( "shared/javadoc/stylesheet.css" ) + bottom = "Copyright © 2001-$currentYear Red Hat, Inc. All Rights Reserved." + links = [ 'https://docs.oracle.com/en/java/javase/11/docs/api/', 'https://jakarta.ee/specifications/bean-validation/3.0/apidocs/', @@ -41,8 +44,6 @@ javadoc { 'https://www.javadoc.io/doc/javax.cache/cache-api/1.0.0/' ] - addStringOption( 'Xdoclint:none', '-quiet' ) - tags( 'todo:X', 'apiNote:a:API Note:', @@ -50,6 +51,8 @@ javadoc { 'implNote:a:Implementation Note:', 'settingDefault:f:Default Value:' ) + + addStringOption( 'Xdoclint:none', '-quiet' ) } } diff --git a/gradle/libraries.gradle b/gradle/libraries.gradle deleted file mode 100644 index 47f3c9344f..0000000000 --- a/gradle/libraries.gradle +++ /dev/null @@ -1,16 +0,0 @@ -/* - * Hibernate, Relational Persistence for Idiomatic Java - * - * License: GNU Lesser General Public License (LGPL), version 2.1 or later. - * See the lgpl.txt file in the root directory or . - */ - -configurations.configureEach { - resolutionStrategy.eachDependency { details -> - //Force the "byte buddy agent" version to match the Byte Buddy version - // we use, as Mockito might pull in a mismatched version transitively - if (details.requested.group == "net.bytebuddy" && details.requested.name == 'byte-buddy-agent') { - details.useVersion libs.versions.byteBuddy.get() - } - } -} diff --git a/hibernate-core/hibernate-core.gradle b/hibernate-core/hibernate-core.gradle index 8f455a2689..6af7b2bcb7 100644 --- a/hibernate-core/hibernate-core.gradle +++ b/hibernate-core/hibernate-core.gradle @@ -313,10 +313,9 @@ if ( jdkVersions.test.release.asInt() >= 17 && jdkVersions.explicit ) { check.dependsOn testJava17 } -javadoc { +tasks.named( "javadoc", Javadoc ) { configure(options) { - overview = 'src/main/javadoc/overview.html' - stylesheetFile = new File(projectDir, 'src/main/javadoc/stylesheet.css') + overview = rootProject.file( "shared/javadoc/overview.html" ) } } diff --git a/hibernate-core/src/main/javadoc/images/bkg_blkheader.png b/hibernate-core/src/main/javadoc/images/bkg_blkheader.png deleted file mode 100644 index 499e91200862ba6287efc506455e8d4bbfe26213..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 2835 zcmV+u3+(iXP)KLZ*U+IBfRsybQWXdwQbLP>6pAqfylh#{fb6;Z(vMMVS~$e@S=j*ftg6;Uhf59&ghTmgWD0l;*T zI709Y^p6lP1rIRMx#05C~cW=H_Aw*bJ-5DT&Z2n+x)QHX^p z00esgV8|mQcmRZ%02D^@S3L16t`O%c004NIvOKvYIYoh62rY33S640`D9%Y2D-rV&neh&#Q1i z007~1e$oCcFS8neI|hJl{-P!B1ZZ9hpmq0)X0i`JwE&>$+E?>%_LC6RbVIkUx0b+_+BaR3cnT7Zv!AJxW zizFb)h!jyGOOZ85F;a?DAXP{m@;!0_IfqH8(HlgRxt7s3}k3K`kFu>>-2Q$QMFfPW!La{h336o>X zu_CMttHv6zR;&ZNiS=X8v3CR#fknUxHUxJ0uoBa_M6WNWeqIg~6QE69c9o#eyhGvpiOA@W-aonk<7r1(?fC{oI5N*U!4 zfg=2N-7=cNnjjOr{yriy6mMFgG#l znCF=fnQv8CDz++o6_Lscl}eQ+l^ZHARH>?_s@|##Rr6KLRFA1%Q+=*RRWnoLsR`7U zt5vFIcfW3@?wFpwUVxrVZ>QdQz32KIeJ}k~{cZZE^+ya? z2D1z#2HOnI7(B%_ac?{wFUQ;QQA1tBKtrWrm0_3Rgps+?Jfqb{jYbcQX~taRB;#$y zZN{S}1|}gUOHJxc?wV3fxuz+mJ4`!F$IZ;mqRrNsHJd##*D~ju=bP7?-?v~|cv>vB zsJ6IeNwVZxrdjT`yl#bBIa#GxRa#xMMy;K#CDyyGyQdMSxlWT#tDe?p!?5wT$+oGt z8L;Kp2HUQ-ZMJ=3XJQv;x5ci*?vuTfeY$;({XGW_huIFR9a(?@3)XSs8O^N5RyOM=TTmp(3=8^+zpz2r)C z^>JO{deZfso3oq3?Wo(Y?l$ge?uXo;%ru`Vo>?<<(8I_>;8Eq#KMS9gFl*neeosSB zfoHYnBQIkwkyowPu(zdms`p{<7e4kra-ZWq<2*OsGTvEV%s0Td$hXT+!*8Bnh2KMe zBmZRodjHV?r+_5^X9J0WL4jKW`}lf%A-|44I@@LTvf1rHjG(ze6+w@Jt%Bvjts!X0 z?2xS?_ve_-kiKB_KiJlZ$9G`c^=E@oNG)mWWaNo-3TIW8)$Hg0Ub-~8?KhvJ>$ z3*&nim@mj(aCxE5!t{lw7O5^0EIO7zOo&c6l<+|iDySBWCGrz@C5{St!X3hAA}`T4 z(TLbXTq+(;@<=L8dXnssyft|w#WSTW<++3>sgS%(4NTpeI-VAqb|7ssJvzNHgOZVu zaYCvgO_R1~>SyL=cFU|~g|hy|Zi}}s9+d~lYqOB71z9Z$wnC=pR9Yz4DhIM>Wmjgu z&56o6maCpC&F##y%G;1PobR9i?GnNg;gYtchD%p19a!eQtZF&3JaKv33gZ<8D~47E ztUS1iwkmDaPpj=$m#%)jCVEY4fnLGNg2A-`YwHVD3gv};>)hAvT~AmqS>Lr``i7kw zJ{5_It`yrBmlc25DBO7E8;5VoznR>Ww5hAaxn$2~(q`%A-YuS64wkBy=9dm`4cXeX z4c}I@?e+FW+b@^RDBHV(wnMq2zdX3SWv9u`%{xC-q*U}&`cyXV(%rRT*Z6MH?i+i& z_B8C(+grT%{XWUQ+f@NoP1R=AW&26{v-dx)iK^-Nmiuj8txj!m?Z*Ss1N{dh4z}01 z)YTo*JycSU)+_5r4#yw9{+;i4Ee$peRgIj+;v;ZGdF1K$3E%e~4LaI(jC-u%2h$&R z9cLXcYC@Xwnns&bn)_Q~Te?roKGD|d-g^8;+aC{{G(1^(O7m37Y1-+6)01cN&y1aw zoqc{T`P^XJqPBbIW6s}d4{z_f5Om?vMgNQEJG?v2T=KYd^0M3I6IZxbny)%vZR&LD zJpPl@Psh8QyPB@KTx+@RdcC!KX7}kEo;S|j^u2lU7XQ}Oo;f|;z4Ll+_r>@1-xl3| zawq-H%e&ckC+@AhPrP6BKT#_XdT7&;F71j}Joy zkC~6lh7E@6o;W@^IpRNZ{ptLtL(gQ-CY~4mqW;US7Zxvm_|@yz&e53Bp_lTPlfP|z zrTyx_>lv@x#=^!PzR7qqF<$gm`|ZJZ+;<)Cqu&ot2z=0000WV@Og>004R=004l4008;_004mL004C`008P>0026e000+nl3&F} z0000!NklGmQM=|$$3_w%@68D6lq)N0Wv5tMH lCCC^|cS$HjJjYMG0{}!MFBD3vL{9(!002ovPDHLkV1nPEJ~RLT diff --git a/hibernate-core/src/main/javadoc/images/bkg_gradient.gif b/hibernate-core/src/main/javadoc/images/bkg_gradient.gif deleted file mode 100644 index 077fa157ed6970353a1d68c8731bd598ac57e369..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 719 zcmV;=0xxy2!ney{~)W+r#bY z+R(?M!?uRc#GdNr*68EW#=4Hmzm?|U&BVBh_x0}I*uLM`zxDI$?CILf!kNRihrhCb z(Z{0i>)yVwef|CVA%BIuGr|Rd`{rvja&#?CO z?$^+;`1kVW;LY^&>(j}n#JGvSvVqmitHHH{=;YGHxQf5Cfy=*@{QCI!_3zTkr`prC z_w?@F)w;^SmCV7J`}_CDx{c-F%+}4T&cvSB(6H0Vrup~s{{8*@{QBkL&A_sO`}+9k zhy{~-o@aO#d_`k4yy|8=v_VK>2d%v@Q&c&U-v3>05 z+VJh;#kh&#+QY)OhsL{()y=H^{QJPOfcyIQ(8i+w|Nj6000000A^8LV00000EC2ui z00;nt000O7fB=GngoOZX2xth42yPx8CMF(haV8r|ZyQBldK(0vpae%6b_}K(8VnOe zbVL)cNj5eRcU2I#2M0I0xd%%T5mFH=!x=48H5th*SPczh4R8%&3k!T49Mv2-Ls~gH zLpn}IF;^uqcqJu0KO`jVStJGXPxJEz_)+-y6)qMo6)Xfykbnh?Is_A-z<~qA85AHu z1hFDPf|rUx!aP7CL&k%T4jk-o@PgzH1#&Q8P@rIC2NfMc$b=anz?_;mPs|XJM#Rn& zWG)Dyap3|DAx$Viq2Pl8Qy?%>Y-y7Ms(`Czu3lvVW&{;ABle8w@_|R54`q0K7%+ef z+qZoz;>w*%x31m0c=PJr%eSxJzkmY^9!$8f;lqd%D_+dFvE#>(BTJr4xw7Iw06XL@ BsB{1T diff --git a/hibernate-core/src/main/javadoc/images/bkgheader.png b/hibernate-core/src/main/javadoc/images/bkgheader.png deleted file mode 100644 index ec13b78badaa48a6c37eca4d9c6e17768a10e648..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 270 zcmV+p0rCEcP)>El1HPZ3QVP5~H&D0$cm?1?K)v_83^`l@No#hSPp}9PR0E8(de-s^ zXdhw`zszzUXD!6c=>&bedM8!pludC6pgQLtpGNo5VX>=wG6>aL^R;OLQsd>|8Ms61 z8a{Xp!sXvo++dW3&80>nZC1JGxe;HYKy2r<_Q#k0;07CPu)#k9yaM{eKAr*$064f{ U0%uPwjQ{`u07*qoM6N<$f)amgGynhq diff --git a/hibernate-core/src/main/javadoc/images/h1_hdr.png b/hibernate-core/src/main/javadoc/images/h1_hdr.png deleted file mode 100644 index 31caf5efb516dbdb7504eaaaa3b00e210a52c438..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 13173 zcmXY2WmsEHw?$ftL!r1!@gl{Y;ts_nSa1*STC_M6_u>wvxD(u+;skdB6t|nc-~E%E z=b7ZpoY^vKuf0yBsS5w+4)?{(5ok^+XK!L@u4Zmx=H)bOE(8b1NgyZrMZ$ctl77FpvhkFLNv7X8h0~}Qzy8Yl%cw06l*F8Zb85Am$claY z#TXm;4MLFEoxiaf^8cjSvLuP8KU|CwJE9$h4GnG5)}!rYzsI%1 z5UsU0R8Y?wQ!4WR2ay+>JUU;CHj%b+nmyG6IZxGoz?K2YMZu};h@ftByVBRJv3*EQ zDIL<$gyk532kn*me*F)NX^sBvV^a+L2Dl5l2>GzMbXIx(sL)Ccn+<9Z_{Mevr&^G} z-{8$5V7Bp;EMSFm^3+}5u|Gs1&rs$mUN-M&Ri8-ur`p)QdyVJ%_31N7T_62F^J=cY ziN2~2Ge2ehQWrnDC*RI~+PHQebAjW=mpuV}xb!_2n|EGn#D&xxYLsi?eE{*^ep@#l z(%%2~n3R`vlHI>pHqW7p+5`v~O>G8ywP7ixORnBSw^nKfZ~Y;p7k+$Y6DmWv|NLht z6FWw_YQP3)d_l`=G7&w#G}(b-_>U}#e)!CptI?`VG3Vij zC;PV_5$#b8`vP6??@Sf$THp&e^5!cq*4Q ze=c-HI*3ZYR**GBDF5fr=d<4y?MS{hu2*wmTx?!h9VYAT$mWA`~TG~@JBD#?{*x!MQ{ zz|-$}J2N--;m?H`DNA_T`>1{Ix<7`6GyM%|a(vbLjravG`_SZT0WmG6*_P{aU5HW3 zIi_LBci+0$_*%{-Um9fhgbSe>Qoh+~j91HH*Y}u_owWZPJdWl(blkoDka zzJQ`7vx=~HnW}7wT7E#YdHVIhTTxDQH?IJ$igAl~dfDv0oh=IVzNK1kamdz$J2`mt z;yXKEvG1a6OhU`e3?tU9xHwyS&)6;MUrO;*eqZZ%e}xKaFU}rPo1h?8rCgbPCgA+^ zkOK>l-l*OrmCSkztqoO{fwsteZi9{6m9_BC1(ihcgQG!(Ie-F=sR zo+4yuyb)g};89Rt103};&4b;WJdB$-25vigprN)1|Kb3uxI^~ffWR>ZP(+`VdnB5` zKB&?eBC#27yeQ(h`ND#C=~oEbT!His2K2rR_tCOA>j7~pfzJY`7)X#p?>~sHY=j#m zZ2GwWY!YHg?b!K~Oup!-m#j)F%93wbn_xf1yqs&rMA$E)UT5fbK#PTrcR)n547JF` z%9n1jZ|S%7;6;vI;e>>}nC9j^IYPI}P{4iGd!igznD&nL4llHq%toH0EEt>t`yXKo zxQU(rn;1L#L3w+Q8}TixQpezm?t*u z4ciKaqm7r(^J=Au=Yj^mQ#Q`m^f*jR+Gg>P{kJMf8kho}I0v)I%TWI8yy?&qqLcjd z8|QxOe)xQIy43Qnmr*Ez)R~Kz_=T`Thru9`E>MipcW~$V;(;gkZ$9;^pX-<`9Z;1! ztY*$;9DNWTe9=7XxQk}`+ooc0emvW}S(b%|WaGFW*bg+HdK|KC!A(g}9$4*91=pXx zSx$H>b+ekSh1OfZpZmTKSfrMmn)XSkhS%n?XYFfDUH;J7?VzQ(NuIa>+yiC_lYA(S zC^ppZyfqxb!OqXXdzJK2>IxliX|d|XYiUb87cc^94%5KNwg`Td*Hz?R%=84XWes9qvhXR#-}_s>5J!&6 zU~d;frzpYmklu;|HFQ9A!yozicbkDOZa16V=$ho8!d6lcPc}IcsZzP){!>gObNfg0 z!Cz%$R~=q{k$2=1ZwI#Mcd+DYbM$b#H^e6?!_EAFvj1H2MP!G}rkSgc^3fq|yb_Z> zOcngL54(=5P346y)z67}UgWRB`f{zC*{OUAUqx!S zjQ?lvr|hB3MNm%x#(TscaboD@!g@0A5o;jcgd9WtyesZS({`hMa9J6OeO$hip5}by z6yl;(8x?6f)#vwtql)M#>H=KFU6tcieq9p4F>U)15&tr)_S9%KIG%OcGBpi;%^8O zukeK;$!a{Aa_7`Zmr2`H&N?KR^atVv4ZefvEc*u^Ql64S=LWCTi-5{muGR)wM&xdB zE!EpC;uc|ZUL}bV(kW~0R-&IbLARaW$t5KyF#MM@L~<9le-3_L`M|Om+vYP#|?PxI2%v(=>ra(<9kAKG_K%A(!qTEbAdYc<7W+0MTqt^IsV#weGNqi9*;blL(!bSwC!T;{3 zJrcC+iA%nLRcE=OZB5Hkl~p^=M(E*XcHYp9JW&E+TSN?#5fPJo4RYgOwd4gK%FTP{9R&#tWOdxX6lT z7TqROMfLZF+Dn*(AXw6}eGQMP+m*YPwabkC(Q6d&VHUHon7O9@SL6lz=F<(2sbCp7 zBmVZhS3=U!rMzS*iZQ%sss>u+r!qQMDE@Ciuf;jm;u}Jv$KJzvuYPgzVXCFVhp*1E zco~_X^wp112e>ZH|C}7#@QoKDM#xkC3}{$!Y(baX*U^rCKoh-i21K;Ad?liF_bZ~> z1jxW^KHgZDEs~sCDp4+xaVnukVfXI`McT0Jk20k+}2q0p(lAU^EvXL9ucXG<+mfTrHDvim0ADB&-L4NXd_x zbrNs^z6TaWzFCh@;zoh@jT=!i1bW?gEy6^AcjT=}{en47?A=Qz%|T)w z-Nf#UQ!L_0D4r^U=+pqJJxj#iayB`2W{aTiWAIJ$8t$A7+pgplDel@lCL|vx<>-B1 z4Ax#ED6HBBI5ydE0Wuy7GM%hK8xmpc?xvP_5PW(1Y{k!;?}(L(z4>X4g^noC+e5Oa z35U8r-99|AK*{_m2i@)i9ltF}B}Og%rr=x%$NFomIN&!5s7bl1ovp|o6PDWUgyi9( zg}1POV&{BoN4xK};+M>9sHM=|{n_mJv00C?K5~O?FjZFLSiJu9Y*59?F^o7w z!fnVlwLBSz>DR`~H42gc(oZtR4@yv$I_HVm$-$<8tg6Qd zLSS)`W3)kq)}X|fLxU0GtNsZS7_iYkcKn7F3L!?4a*YsZQZL8Q|wmBiz2%G?fOfDQW5^aZc&a$ra> zj)2D>qq&wDvb{#pxv{;G9AUz5Rs;~Ae**pa;w)>N=X@;_vuItXLwr3r;Tm0Rc_&DE zW*D?Tu>H6|_W5u{a0(Gl`=(2~DOD44-2RtTFgd_1&dZB(0ivz!S9&cN1kK_zH%-j? z;dg~okH`&x@(OK8Rv#Yq1DP-gGGJ9;aJ^1pn8LYCF)aRobsb?w(D-BwvrD2LxU+bL z?$>mAa8YWSlydnfye00ok>I%|oxXoh7;yg^n(6Ev){l zw``Dd7vCkjrKX>!!9cmebYG-I`-qKPLhm?qF`NF`o8w0s zSv3UpRjml}-BkzeP_hUzgDpY3QBMIocdvvqw}tsR^0?O!)hUw06lgfqFFHi7zxYzv zG;3tQNmMQI6gC!OAG1e(y$)5kMnJd!w~oz;2k)9$PoeY=$D{1m2~DCQAo=RoM#N#owUQY`*9piFiY7E0ZzPYFzb3AhCGf_0wo;>jC5{Fu)uN?XS|px; z0*DXIh*MmVNQOx5F99~>1s|mc=X<19uS zrC07@hNI8xD^AB~Gw<)6F|_+W=Tl~U3!+4B_gHss$l`Ae!mJ6q52B1@+}$oKjA!uh zv7b|MXWPN-8r}Wg^!r29UP?+H88k6U+#LoOxly6Jl|1QX$CtAp5vq# zn?z;p0gH9ZUPE@`PmkMPpHCNM{MR;r)Hv#kR|B5m4RmFDM~aRh!h5=}vuYOOXe7IV zx!guqh+l}O593C63-r5ikwe~f`yRnBudO@p%KQZ`^V%a%%BWYeCG?>ymDeYWa&b6B zd@mW|Hpt`R+8(K?Cx*cTAr8ZFecyYM7LEr7%et6ziza$DGx4PoqoL@tfDySdYHq-# z{2R7Mwd>F%#EC96rE<%K7E^|aN$B!IUegCt}IOh1=U z5LD{k<=HtI@n$9kdp6!#FZ^>eJox}Q5Ai0mrcD^+mhSV#%>~srv4mJ^A3LxKC zExtqFa&0PjRdAX!@prqul!RKFKhY*Uaci>gi70e8+d0gfn^1K z^Prx*Zd}xcnM!>Mq)2o7E1Svw-)EJiLu$3|`B5}8--RPoZH%-#O$qF% zc?A*$L6J?6`8zNb1xPnrd%TSSv+7Ke0$RCC!eM83`m zwZjST4iWixLEHCG)>H)=>|p-%)+aJdek~DP=-EeiAuU$g`ZB(*vFWqlU)|LP)u-+% z%p@Cr68tn^oh+7cHDBp?FHgKlk*kGp*n2wuI_|uC1%Bbabd$3jasU2Mii5n7(Y_JTKJjrM`WuIlbKo3n0-snGeEqu7IlA{f!@w*h zIi4GEybH%)xpXnkvJrcU=C%|*N`CDHuS{)0Dfcx$I9cSZJ&Fs^A3eQiC|d-}7R6Vr zf`i1YJ2EM9C0`TPTDq9`-x4e9b<%&Xv-8~>^nT#^QF^xygINKJ15$NqWYMOAb%bw7 zF}T`W4Ign0NgZUDi_G-cMZPintoi5u3JtPTFNMHDY};DUl&xQ%LB|U51x~+4mY)`P z{M3Kk;w$j);X`YD)>W$l7ul~C#dJCqJ#6UlM7Z5;(k53bvL~C-igMoL>-N0;jBC7( z9b14=mJxazMM#&*8=5oB@Sv%uHy@Ucchj^<2xmI<7#6Vs6Ro;4UTNaNDA7?|0fPm$&4tfX zPrdGiVYZ#n9kA)_p;1&}gq)kKQ+u)+iv>f5ZVw1M9$etDVsoy!FEw#tlTr#RKhAou zxM62^K18kICkmo}-t4L&DRX#8U>totGIN@1^!_8$dip{vPdsED?~sFXvb(Lm(?3Se zloEG>7Yc8wt<~@s?3YYE7WMc1yPYiVAy<=!wlEC9>s?w9SD*GZt6db@SoC`|ETawl zeZXHV=QfDxQ|!M@s3w58$QMC^_dfu)pk7roc3>=qYskD#LWaEvWjG~ZcAouTzIm6W z;-_KTnjzCJ4KAt!N@?FDObt<)t5D&CIw&bV>X>wMpR0MH4zqfGsm)Qosf?{aH`9m= z&1Ww`>#AqEq8@MK!Z@Jj#JO~%!tNyUx*}#xKT6w@D_TkkSP+{64cjxg6q}q}K-8uq zVG{s>Fx_vuCMayvxOBPT9rnKhJui) zngod)W*in8`S?i(A^x5%Za}$*wa}YgS_?=ldApQqvQF(P!WsnIzFGU)A`~`8JRxmC ztKo}_j0HwnXul8tK!Y?#SpI{N zFVT{<{mvQiMXm23#K<7bgS(=od_COumk6^y0}UhHciVvX%4WUb4DAPYx(QmP7cT>5 zI-4!XT4U>Tsl^8*c`ThubcHf->(&SDTI?Y>@HRctJ`O8@p3gR!pYt z3-oM-OsSiQ!|dwq%crD6bnE6{hk@GS-Oc{SG#HBp3RASb+#|)n_D+;)J0Z<4bJuqR z87*7)c~|7SI`_UoSj|)dQj9bcjJ{+sU%VP&+HS7&v^77lCHbm*J8MhEr;Dz(Eb|=@XtJ`Ue_nvnI z6IQ30Vxdg~=NIt&^PR{%fp4=Sg=V)!%ZsQixFLk|2(2(#;Vt4sHYc0NUEtcQ?`ysm zwuo0~3JD^O(S2kp+m}nOgEcdp+&I)bihyT4-W3JjVieE(C&XXBNfbq6`}lU$dqOfr z0;$`)7z=66Mg8S#+H5aIEUsc?ZYq#2OSxY|ixU>2CQ8|cN)l!P##@5Ed_Mci`qhNM zq$GHU1L%q62hc``gi}OjQ0?Hz$U+8!=Ij0`g|u&8S5U$uxo^&G24xF*k;wBbR^3KNwSxyaRnBYa1SiG1 zuVb_@LI=C+I$0B(Wj{cNc5(PO?SKF`a~haaP`jnlJ7v(o`V(=vKCA3N#==}#j8ti0 z@s>}Aj-q)8b(G%y{#=jIu$kpC-J zmQ0S)bsCB*meTU3LHTq0JIuvnM=~{S8fy^ef<|`ED88QMJaiPY&w ze_W0jC|DV$mcB_BKoWB=RdK;rdf?m4qXi7=BtjT4;YOjl@*{)}DHlfvaoy;Y`zaB3 z^12?iTXpjOCc!lu^)>{DA~|RGlY||^74VAdM$BN0S znY40Xc{x~*7(=^I2i*oJ_{pkSXmUICi0XQ{7{Sn{7B8xQG!*@{dZ9zLeFVlt5E)BZ zh7*-deDfG4X6+EbLjG)Gia|gDh1Hz30Tr;citImY@cZnuWziKz%xkHyIn~{+xLS_t z`F$gWEouWM4Yxhr`t zG%H^?BT!Eo5lF-muL}YFkpNVCkW&9w*LLex2^{#5Ucbd4nEP=S>|tBJc;hE(&rx7h zW%?^@l*o-12FT3sW_uHVzJo(OFisXv{8`zt#|=2tz_)IG@qJAd#^nO!(Bh9K*M`~h zyoMmj(+8v69y^oOaKFV^44=%!AgH)f?LJlP(84{bL!x+1T?q zTpeh-J-#rg#dfELF8G6NzO;Wo19`cSe6R8ipA2#(K>VvI?kxKl*vp$bdfD<8P;|89 zcu>JbH~9c^7E>(gr|yx zZ0DAwK{t*KJmK3*hPGW2XHff)WO&Q^TOTPGt4<~y$V}W`#fL-IZvExq(T}6aY;4%1 zGkX)?>HFI)o4VOl%3(zmtRrQ5EEx04F^3S7RwIYdRRmxo`uT6XH+o)9JTFb?Ad;6vrh>{yK2Q-zf+^J_A?%b|#6JMS;mo~i85oI^P^rGrD* zV4Q{SuuoE>!p3CPDx)~q4H?Es0GLF7Ay(vq6DEEnpzu_{U_-Ull6F|x)emA;3|w2^ zW(~#4y1|*!2(0t(WH{djFlQsw{OjgqV34Rxg%H#cc6{NyySJFZ=PZ+S1SLcya|=h* zt~>n5--G&2O-XzRUX+$*y7417_5OE_fjuLK-gjn^RdV=IyYl-b!Ubv8yO%K+P^9@j+xkFSsrE2tH5Q&* zpe%TvB>MVD$Wyx)f6gnO2s$|>>qbs$SY^2Pk1uQ&UYOEFBtu;;`c0HJY(_oMg;q_M z)fq;3H1Et~f906YCS;gR&)h{xR|IH}SGqiZaBawRH7~h04Pu*OPW1!yc9}E9%u~{G4c~dXmEav1Spf@3_1uOhN zSrfAnpQ=Kc>V= zg>8l2n^>n}gaj=lS^@+Df-$>bUTDH@bdq4LM;qEO%FEB*cu7BL6DC{+i$2?0)Ig^`G=isi?!WAdj;^nm+7#1YzU z8VOcMFy{I7E`N+cXw)yX;YE5ER zFOy6aKk9pt84EKuj#4gorU!W7lobMcgN~x9plQ}`{nG4_(biEYRKwrw7kn+}=@Et* z<#htDRY+M}mT}omyu#!X8-CK~ME1owo#lMNtjSNxGmunR&kkc)--v_sY{FA7B*PvS zd|ZIfxSX)$G!H6Mti2{?ZAru=TY$-6BGlfWe?%%qiJ(P_AuFz&K!Y98I*JWaP_fYm za6-(C6c}RtG(_!oIXk`fO`U>E^*{#SnxuVk&tO7U=T%*TIs6AFPKth3A(#!;)>=ty z%1;B^@sw}an4-KIt8vs77dg@5N+tl*b^u3f4;)~iTEmYx z+Y|QPxp1Wu+q;)hh}5Tdl$`-WTNkubY z)&Y~+a*1r++J{@{=hIt=Glf7$5g_ z=H8e7-an>xO0Q69MZtcIc$*{UruOb)*Liqf7-XYRFje~FKJfJ(^6>inl4+5r(aJz^ zv@Wq&!;>qmyKk zny7?1avO#WAIIfMHKhz3YDRbO`2#$=Zzoo-o(a3Qqms8fYCf6@B$sQxrG5grolBms zWlVgFkIWz1d*{4=b!Lo|tj<9q(V*dT7aDCZ=%huU73^43onIRkG*wLL0SV7S?Kfx2 z-ajl64Q2uAF{b|Q>*kzlRM=xmuDzQJuObakCjGE<-@X~)wb7A?i0MX7%W86jD8)k& zzHZE(#liyK;T^4WF!j!UG89v4za1DgukRNZ0Z1<`hj8BqdYrFZg*GiV_?(MD(?JHk z^B9^*SPU5f_ZM|M=QV7T8y&CMFHEB}o0uv(cLU73mC%8t5*3&VW7tFunYxDypsJXM zzt|3Q^2-u}s4_0VFP&)ZeJPvfosTw#Qlw=tCO`55bUMra!=QeX!lopj85PW$uIFY* z`)tJp|Cu?Y;`&m)ub1p_zd|MSbflkL^mD|(Hip?ISYpLklSV|AhMW!Glt_-xs!&LL zdrv{Ss7wzaW7D`a$rPC`FJ5U0gkfRBpO_e3|H4p@!`y}iW5dyQ6%y2k z&HB?ejc^*P%agPWC2&rL20u#CPkH4?|Lxu}kRfZQYhBs)xAQA|Er!9vKpRBU-&gu) zf<*bMZK z681MiRW;5jY5gCi(4Q?K#~B4YI8nMklQWzCs{VCwa7-))*}0Uxmc3^qP!ODToV*e! zAmNIy!$C@fb$UxfO$=EYI~bO1ItFqtOEMpg0!D-zuIYSVY8*3W6DTwE@BhTvQMFWy zz;!*{+0=3bwh>@;Z?dtWj)Fn5;YQ55RnzGFFcIc0FT6(G^97D(_)~A=g(etJz$RVm zmtdN-BFUc8nHOqM<5qGqu@Ze1Lxoh_7+?|A_6S)>vT^O4UctX*HmA^2e>&6 zzdjqEOl0vJv51gSKOSDJdtrwsok(uzEX(=)>8-X6bNV$PlyUlK(p@%0_n(mM&kxhT z2!{S~VYXXH5$a3p$MOD{y7${{66IWgFfE{a^RLw0#pIQEL|n(4P{G#5!ctrOOsPfK znd8REoJ_aL@Bo3a$2xWpuSpPF*~8&*PXO%>`IT?4Yq|2xfJjLTcqI`BCgD8CrTLGi zQU-I!E}W3=)|0u1&%tPL98O(u(U*hZvd?$XW?LW}>cn%520AhDZP>E=9>W8QdafmQ z)al#fl5l61;t9d3WVX3J=bzm;#RbcWB6KwT<)0W~jp$2}kMUv5iIHet*3OJY_DDh>(a>JHDV2epDF9u20gfBo&Dxp2mHONR02{_&!e9Wik7z3jsIN zojZ3$Q#SS(sUAO3t6#EU>QKnvpOrm)zv)}QFdL&lq2P}Br%)t4FNDa4pmes^ZZmTZ=WUUzG##r?opLqjq@f^ok7^C;Ntcr42qOeB!6f7Mv{f zNW$o@Ysrh+if7I#k$e%md){9xc(F8u>B?$^B6UvUGx&^zWc>d4kM-vQk2Uh2P<5Aw znfleuX?>r%l1*{`Z4zcw--PeZH|nL{R3 z^O+0ZE$AXKx^{?UFLZr54%%h93q+TOuD0_c52<*ZWb-gsT|W{&Xb0-=&nsJ zxz-aytr2<|L)0VtF@v&4R-|8uki=8mRWcH=O>mLfuwPfLT^LyJQOxE^YlS)2IeL;?~_^nk!x;#RKm1_M* z`Pb)ibvY92Ml3l$4WHkHJ95afeu<4mTaWKbL@tq-ijzd`*I}IzWVSbTl*lg-s)JjH zsQ_>-eL)A8dbyf8W0&gnnp@ovFUPEg^ZordN0Q*pa&t9{I z9Uei231#^pn?!59NY|yk9e$h(ilEzScysJN>bn!KbtTJ*{ZHfGErxilX6sGWcXY-q zixBJeXrkALYm8i6SMP7)CX=!5r4x(IV!Uy}G%y*-9V<*&{z1VFR=pSH-L2>$sP_uw z(f#6w;&z1=X&4eGV?mEEAp+3fPdD7@evPJrYVk=f}T2 zbcexoSQf+h$*a1n7;|3yejYC&T?R&HiAkxdoD0($f*W+Ul*#`w>&tAk-b~p-YTGK7 z^;3t6%6`#R0xIBJnWBF>HRvr;l~=%Srt5nf-9kwDg3G~V{PbQQHxqDU(wkj5W1{qx z-`BjeJBEX9mQl2fJaS#^&#I8?!gZ_a_-%NBr*r46OAh@t;}0XMPtS4uoXkg~-hPm1 z%Ih+1w6YxsaN54t(tI>lcAe&7L2Z0s)_)$`f_e#uLGWSA_d>gB;XaY<`-xV~JcF*P zcNm*qT}&7=V7Gzg3LDJEuyOyh{;Mq%@xF88an2pz1J>l7RX{c{TT~9&(>3KI51&Pe zch@K<=&c-h#EPw#{ix+TsLn9x=+jo_40M2b5xdp$lMa{7d@V<#jhca$>F#V@d>kg1 zID9achcpa3%`TxIKz&fw7Bt)lSYal8=(GCqW?*3^HbeJ4OiGz>JH06gs>skCR+y_K zz-8ve;uUYP;^}o(FM@dI_@~mV`0eoQKq7~Z9@wu@5XE8kg$eezyKR6=9#`A**VVB< z=H~usYhwz$86D8Z6Ai(;UZdx-;C?lV(a)Jbi7AwWntn?hd8a%K`NB$IJLHHPj>KL#VO8OKFzbB>~hGT`h1;AYB?`fylBfd%vDu00tHLgOxTVDqjK55 zi0xcr{BGgT|8YPr%?(zDwzKNQ<})=-`A+qaCFor%jHDKMCGVosU# zg*65>k4#r0U6|TXU=+!@`j0oZaY4Mf&9TO$do|<0`=|KqRT+~8y>6W+=3}>bS-h@e zYP_mlM+X_^BxTEkP8gF2dtU=~f0zhWE6>{HzpGBpr(8HhIQVZUfWQ9III#C<;N+x~ KC9B1agZ~e0nDu!8 diff --git a/hibernate-core/src/main/javadoc/overview.html b/hibernate-core/src/main/javadoc/overview.html deleted file mode 100644 index fa692b4901..0000000000 --- a/hibernate-core/src/main/javadoc/overview.html +++ /dev/null @@ -1,257 +0,0 @@ - - - -

Hibernate ORM aggregated API documentation

- -

- Hibernate is a library for object/relation mapping (ORM). It provides: -

-
    -
  • - a native API centered around {@link org.hibernate.SessionFactory} and - {@link org.hibernate.Session}, -
    • -
  • - an implementation of the Java (or Jakarta) Persistence API (JPA), - where the equivalent central interfaces are {@link jakarta.persistence.EntityManagerFactory} - and {@link jakarta.persistence.EntityManager}, -
    • -
  • - a set of mapping annotations which augment the O/R mapping annotations defined - by JPA, and which may be used with either API, and -
    • -
  • - compile-time tooling for writing more type-safe code. -
    • -
- -

Native API

- -

- Along with {@link org.hibernate.SessionFactory} and {@link org.hibernate.Session}, applications - using the native API will often make use of the following interfaces: -

-
    -
  • {@link org.hibernate.cfg.Configuration} to configure and bootstrap Hibernate,
    • -
  • {@link org.hibernate.StatelessSession} for processes involving many entity instances,
    • -
  • {@link org.hibernate.Cache} to manage the second-level cache,
    • -
  • {@link org.hibernate.Transaction} to control local transactions,
    • -
  • {@link org.hibernate.query.Query} to execute HQL queries,
    • -
  • {@link org.hibernate.query.NativeQuery} to execute native SQL queries,
    • -
  • {@link org.hibernate.Filter} to manage filters,
    • -
  • {@link org.hibernate.query.criteria.HibernateCriteriaBuilder} to construct criteria queries, - and
    • -
  • {@link org.hibernate.relational.SchemaManager} to execute DDL in tests.
    • -
- -

JPA

- -

- The JPA interfaces are defined by the JPA specification. For details see the latest - specification along with the - API documentation - for the package {@link jakarta.persistence}. -

-

- Note that since Hibernate 5.2, the native API extends the JPA API rather than wrapping it. - For example, SessionFactory extends EntityManagerFactory, and - Session extends EntityManager. -

-

- It's always possible to fall back from JPA interfaces to native APIs, by calling - {@link jakarta.persistence.EntityManager#unwrap entityManager.unwrap(Session.class)}, - {@link jakarta.persistence.EntityManagerFactory#unwrap entityManagerFactory.unwrap(SessionFactory.class)}, - or {@link jakarta.persistence.Query#unwrap query.unwrap(Query.class)}. In certain cases - it's also possible to access native functionality by passing a - {@linkplain org.hibernate.jpa.SpecHints JPA-defined} or - {@linkplain org.hibernate.jpa.HibernateHints Hibernate-defined} hint, at the cost of a - loss of type-safety. -

-

- These packages define additional extensions to the JPA APIs: -

-
    -
  • {@link org.hibernate.query.criteria} packages extensions to {@link jakarta.persistence.criteria}, and
    • -
  • {@link org.hibernate.metamodel.model.domain} packages extensions to {@link jakarta.persistence.metamodel}.
    • -
- -

Mapping annotations

- -

- The mapping annotations defined by the JPA specification provide a foundation for expressing - object/relational mappings in Hibernate and other JPA implementations. -

-

- The annotations in the package {@link org.hibernate.annotations} extend this foundation and - accommodate more specialized requirements. These annotation are not tied to the native API, - and may be used in conjunction with the JPA API. -

-

- The full power of Hibernate can only be unlocked via judicious use of these extra annotations. -

- -

XML-based mappings

- -Annotation-based mappings are the best choice for most users, but Hibernate offers XML-based -mappings as an alternative. - -
    -
  • - The JPA-standard XML schema is - orm_3_0.xsd. -
    • -
  • - Hibernate extends this schema with some additional mapping elements. The extended schema is - mapping-3.1.0.xsd. -
    • -
  • - Prior to the existence of JPA, Hibernate had its own format for XML-based mappings, - which still works, though it has not been improved in a long time. The DTD is - hibernate-mapping-3.0.dtd -
    • -
- -

Annotations driving compile-time tooling

- -

- The annotations defined by {@link org.hibernate.annotations.processing} instruct the Metamodel - Generator to {@linkplain org.hibernate.annotations.processing.CheckHQL validate HQL at compile - time}, and to automatically generate the implementation of - {@linkplain org.hibernate.annotations.processing.Find finder methods} and - {@linkplain org.hibernate.annotations.processing.HQL query methods}. -

- -

Bootstrapping Hibernate

- -

- There are four basic ways to obtain an instance of Hibernate: -

-
    -
  • - as a JPA persistence provider, by using - {@link jakarta.persistence.Persistence#createEntityManagerFactory}, -
    • -
  • - by using the "simplified" {@link org.hibernate.cfg.Configuration} API, -
    • -
  • - for those who enjoy dirty hands, by using the APIs in {@link org.hibernate.boot}, or -
    • -
  • - in a container environment like - WildFly or Quarkus, - by letting the container take care of the bootstrap process and of injecting the - {@code EntityManagerFactory} or {@code SessionFactory}. -
    • -
-

- All major Java application servers and microservice frameworks come with built-in support for - Hibernate. Such container environments also typically feature facilities to automatically - manage the lifecycle of a {@code EntityManager} or {@code Session} and its association with - container-managed transactions. -

-

- Example configuration files for JPA and native usage may be found {@linkplain org.hibernate.cfg - here}. A comprehensive list of configuration properties understood by Hibernate may be found in - the class {@link org.hibernate.cfg.AvailableSettings}. Most sensible programs will only ever need - to use a tiny handful of them. -

- -

Popular extension points

- -

- Hibernate offers an enormous wealth of extension points for customizing almost any aspect of - its implementation. Most of these extension points are far too technical to be of interest to - the typical application developer. -

-

- However, the following extension points are of quite general interest: -

-
    -
  • - {@link org.hibernate.boot.model.naming} allows the quantity of repetitive O/R mapping - metadata to be minimized via the use of naming strategies, -
    • -
  • - {@link org.hibernate.type.descriptor.jdbc} and {@link org.hibernate.type.descriptor.java} - contain the built-in {@code JdbcType}s and {@code JavaType}s for "compositional" basic - attribute type mappings, -
    • -
  • - {@link org.hibernate.usertype} defines support for user-defined custom attribute types, -
    • -
  • - {@link org.hibernate.generator} defines support for generated attribute values, -
    • -
  • - {@link org.hibernate.context.spi} defines support for context-bound "current" sessions - and contextual multi-tenancy, and -
    • -
  • - {@link org.hibernate.binder} allows for user-defined mapping annotations. -
    • -
-

- More advanced extension points include: -

-
    -
  • - {@link org.hibernate.dialect} provides a framework for modelling dialects of SQL, -
    • -
  • - {@link org.hibernate.cache.spi} defines an SPI for integrating with second-level cache - providers, -
    • -
  • - {@link org.hibernate.engine.jdbc.connections.spi} defines an SPI for integrating with - JDBC connection pools. -
    • -
-

- Finally, Hibernate ORM Core is itself a framework for advanced extensions like Hibernate Search, - Hibernate Reactive, and Envers, which do much more than just implementing a single well-defined - extension point. The starting points for such extensions are found in the packages - {@link org.hibernate.integrator.spi} and {@link org.hibernate.event.spi}. -

- -

Package categories

- -

- The organization of code into packages is based on the following classification: -

-
    -
  • - API packages include classes and interfaces which are used directly by - a typical application. These packages never have spi nor internal - in their name, and are not under the namespace org.hibernate.testing. -
    • -
  • - SPI packages include classes and interfaces which are used by integrators, - library developers, and framework developers to develop extensions to Hibernate, or to alter - its behavior in some way. These packages usually have spi in their name. -
    • -
  • - Some classes and interfaces are considered part of the internal implementation of Hibernate. - This category includes packages with internal in their name, along with any class - or interface annotated {@link org.hibernate.Internal @Internal}. Clients should avoid depending - directly on these types. -
    • -
  • - The hibernate-testing module, and the namespace org.hibernate.testing - contain testing support used in the Hibernate test suite. -
    • -
- -

More information

- -

- Complete documentation may be found online at - http://hibernate.org/orm/documentation/. -

- - \ No newline at end of file diff --git a/hibernate-core/src/main/javadoc/stylesheet.css b/hibernate-core/src/main/javadoc/stylesheet.css deleted file mode 100644 index d5c335fb9c..0000000000 --- a/hibernate-core/src/main/javadoc/stylesheet.css +++ /dev/null @@ -1,948 +0,0 @@ -/* - * Hibernate, Relational Persistence for Idiomatic Java - * - * Copyright (c) 2010, Red Hat Inc. or third-party contributors as - * indicated by the @author tags or express copyright attribution - * statements applied by the authors. All third-party contributions are - * distributed under license by Red Hat Inc. - * - * This copyrighted material is made available to anyone wishing to use, modify, - * copy, or redistribute it subject to the terms and conditions of the GNU - * Lesser General Public License, as published by the Free Software Foundation. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY - * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License - * for more details. - * - * You should have received a copy of the GNU Lesser General Public License - * along with this distribution; if not, write to: - * Free Software Foundation, Inc. - * 51 Franklin Street, Fifth Floor - * Boston, MA 02110-1301 USA - */ - -/* - * Custom Hibernate javadoc style sheet - */ - -/* - * Javadoc style sheet - */ - -@import url('https://fonts.googleapis.com/css2?family=Inconsolata'); -@import url('https://fonts.googleapis.com/css2?family=Lato'); - -/* - * Styles for individual HTML elements. - * - * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular - * HTML element throughout the page. - */ - -body { - background-color:#ffffff; - color:#353833; - font-family:Lato, 'DejaVu Sans', Arial, Helvetica, sans-serif; - font-size:15px; - margin:0; - padding:0; - height:100%; - width:100%; -} -iframe { - margin:0; - padding:0; - height:100%; - width:100%; - overflow-y:scroll; - border:none; -} -a:link, a:visited { - text-decoration:none; - color:#4A6782; -} -a[href]:hover, a[href]:focus { - text-decoration:none; - color:#bb7a2a; -} -a[name] { - color:#353833; -} -a[name]:before, a[name]:target, a[id]:before, a[id]:target { - content:""; - display:inline-block; - position:relative; - padding-top:129px; - margin-top:-129px; -} -pre { - font-family:'Inconsolata', 'DejaVu Sans Mono', monospace; - font-size:15px; -} -h1 { - font-size:20px; -} -h2 { - font-size:18px; -} -h3 { - font-size:15px; - //font-style:italic; -} -h4 { - font-size:13px; -} -h5 { - font-size:12px; -} -h6 { - font-size:11px; -} -ul { - list-style-type:disc; -} -code, tt { - font-family:'Inconsolata', 'DejaVu Sans Mono', monospace; - font-size:15px; - padding-top:4px; - margin-top:8px; - line-height:1.4em; -} -dt code { - font-family:'Inconsolata', 'DejaVu Sans Mono', monospace; - font-size:15px; - padding-top:4px; -} -table tr td dt code { - font-family:'Inconsolata', 'DejaVu Sans Mono', monospace; - font-size:15px; - vertical-align:top; - padding-top:4px; -} -sup { - font-size:8px; -} - -/* - * Styles for HTML generated by javadoc. - * - * These are style classes that are used by the standard doclet to generate HTML documentation. - */ - -/* - * Styles for document title and copyright. - */ -.clear { - clear:both; - height:0px; - overflow:hidden; -} -.aboutLanguage { - float:right; - padding:0px 21px; - font-size:11px; - z-index:200; - margin-top:-9px; -} -.legalCopy { - margin-left:.5em; -} -.bar a, .bar a:link, .bar a:visited, .bar a:active { - color:#FFFFFF; - text-decoration:none; -} -.bar a:hover, .bar a:focus { - color:#bb7a2a; -} -.tab { - background-color:#0066FF; - color:#ffffff; - padding:8px; - width:5em; - font-weight:bold; -} -/* - * Styles for navigation bar. - */ -.bar { - background-color:rgb(89, 102, 108); - color:#FFFFFF; - padding:.8em .5em .4em .8em; - height:auto;/*height:1.8em;*/ - font-size:11px; - margin:0; -} -.navPadding { - padding-top: 107px; -} -.fixedNav { - position:fixed; - width:100%; - z-index:999; - background-color:#ffffff; -} -.topNav { - background-color:rgb(89, 102, 108); - color:#FFFFFF; - float:left; - padding:0; - width:100%; - clear:right; - height:2.8em; - padding-top:10px; - overflow:hidden; - font-size:12px; -} -.bottomNav { - margin-top:10px; - background-color:rgb(89, 102, 108); - color:#FFFFFF; - float:left; - padding:0; - width:100%; - clear:right; - height:2.8em; - padding-top:10px; - overflow:hidden; - font-size:12px; -} -.subNav { - background-color:rgb(188, 174, 121, 0.5); - float:left; - width:100%; - overflow:hidden; - font-size:12px; -} -.subNav div { - clear:left; - float:left; - padding:0 0 5px 6px; - text-transform:uppercase; -} -ul.navList, ul.subNavList { - float:left; - margin:0 25px 0 0; - padding:0; -} -ul.navList li{ - list-style:none; - float:left; - padding: 5px 6px; - text-transform:uppercase; -} -ul.navListSearch { - float:right; - margin:0 0 0 0; - padding:0; -} -ul.navListSearch li { - list-style:none; - float:right; - padding: 5px 6px; - text-transform:uppercase; -} -ul.navListSearch li label { - position:relative; - right:-16px; -} -ul.subNavList li { - list-style:none; - float:left; -} -.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { - color:#FFFFFF; - text-decoration:none; - text-transform:uppercase; -} -.topNav a:hover, .bottomNav a:hover { - text-decoration:none; - color:#bb7a2a; - text-transform:uppercase; -} -.navBarCell1Rev { - background-color:rgb(248, 152, 29); - color:#253441; - margin: auto 5px; -} -.skipNav { - position:absolute; - top:auto; - left:-9999px; - overflow:hidden; -} -/* - * Styles for page header and footer. - */ -.header, .footer { - clear:both; - margin:0 20px; - padding:5px 0 0 0; -} -.indexNav { - position:relative; - font-size:12px; - background-color:rgb(188, 174, 121, 0.5); -} -.indexNav ul { - margin-top:0; - padding:5px; -} -.indexNav ul li { - display:inline; - list-style-type:none; - padding-right:10px; - text-transform:uppercase; -} -.indexNav h1 { - font-size:13px; -} -.title { - color:#2c4557; - margin:10px 0; -} -.subTitle { - margin:5px 0 0 0; -} -.header ul { - margin:0 0 15px 0; - padding:0; -} -.footer ul { - margin:20px 0 5px 0; -} -.header ul li, .footer ul li { - list-style:none; - font-size:13px; -} -/* - * Styles for headings. - */ -div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { - background-color:rgb(188, 174, 121, 0.5); - border:1px solid #d0d9e0; - margin:0 0 6px -8px; - padding:7px 5px; -} -ul.blockList ul.blockList ul.blockList li.blockList h3 { - background-color:rgb(188, 174, 121, 0.5); - border:1px solid #d0d9e0; - margin:0 0 6px -8px; - padding:7px 5px; -} -ul.blockList ul.blockList li.blockList h3 { - padding:0; - margin:15px 0; -} -ul.blockList li.blockList h2 { - padding:0px 0 20px 0; -} -/* - * Styles for page layout containers. - */ -.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer, -.allClassesContainer, .allPackagesContainer { - clear:both; - padding:10px 20px; - position:relative; -} -.indexContainer { - margin:10px; - position:relative; - font-size:14px; -} -.indexContainer h2 { - font-size:13px; - padding:0 0 3px 0; -} -.indexContainer ul { - margin:0; - padding:0; -} -.indexContainer ul li { - list-style:none; - padding-top:2px; -} -.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { - font-size:14px; - font-weight:bold; - margin:10px 0 0 0; - color:#4E4E4E; -} -.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { - margin:5px 0 10px 0px; - font-size:15px; - font-family:Lato, 'DejaVu Serif', Georgia, "Times New Roman", Times, serif; -} -.serializedFormContainer dl.nameValue dt { - margin-left:1px; - font-size:1.1em; - display:inline; - font-weight:bold; -} -.serializedFormContainer dl.nameValue dd { - margin:0 0 0 1px; - font-size:1.1em; - display:inline; -} -/* - * Styles for lists. - */ -li.circle { - list-style:circle; -} -ul.horizontal li { - display:inline; - font-size:0.9em; -} -ul.inheritance { - margin:0; - padding:0; -} -ul.inheritance li { - display:inline; - list-style:none; -} -ul.inheritance li ul.inheritance { - margin-left:15px; - padding-left:15px; - padding-top:1px; -} -ul.blockList, ul.blockListLast { - margin:10px 0 10px 0; - padding:0; -} -ul.blockList li.blockList, ul.blockListLast li.blockList { - list-style:none; - margin-bottom:15px; - line-height:1.4; -} -ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { - padding:0px 20px 5px 10px; - border:1px solid #ededed; - background-color:#f8f8f8; -} -ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { - padding:0 0 5px 8px; - background-color:#ffffff; - border:none; -} -ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { - margin-left:0; - padding-left:0; - padding-bottom:15px; - border:none; -} -ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { - list-style:none; - border-bottom:none; - padding-bottom:0; -} -table tr td dl, table tr td dl dt, table tr td dl dd { - margin-top:0; - margin-bottom:1px; -} -/* - * Styles for tables. - */ -.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary, -.requiresSummary, .packagesSummary, .providesSummary, .usesSummary { - width:100%; - border-spacing:0; - border-left:1px solid #EEE; - border-right:1px solid #EEE; - border-bottom:1px solid #EEE; -} -.overviewSummary, .memberSummary, .requiresSummary, .packagesSummary, .providesSummary, .usesSummary { - padding:0px; -} -.overviewSummary caption, .memberSummary caption, .typeSummary caption, -.useSummary caption, .constantsSummary caption, .deprecatedSummary caption, -.requiresSummary caption, .packagesSummary caption, .providesSummary caption, .usesSummary caption { - position:relative; - text-align:left; - background-repeat:no-repeat; - color:#253441; - font-weight:bold; - clear:none; - overflow:hidden; - padding:0px; - padding-top:10px; - padding-left:1px; - margin:0px; - white-space:pre; -} -.constantsSummary caption a:link, .constantsSummary caption a:visited, -.useSummary caption a:link, .useSummary caption a:visited { - color:#1f389c; -} -.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, -.deprecatedSummary caption a:link, -.requiresSummary caption a:link, .packagesSummary caption a:link, .providesSummary caption a:link, -.usesSummary caption a:link, -.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, -.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, -.requiresSummary caption a:hover, .packagesSummary caption a:hover, .providesSummary caption a:hover, -.usesSummary caption a:hover, -.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, -.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, -.requiresSummary caption a:active, .packagesSummary caption a:active, .providesSummary caption a:active, -.usesSummary caption a:active, -.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, -.deprecatedSummary caption a:visited, -.requiresSummary caption a:visited, .packagesSummary caption a:visited, .providesSummary caption a:visited, -.usesSummary caption a:visited { - color:#FFFFFF; -} -.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, -.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span, -.requiresSummary caption span, .packagesSummary caption span, .providesSummary caption span, -.usesSummary caption span { - white-space:nowrap; - padding-top:5px; - padding-bottom:8px; - padding-left:12px; - padding-right:12px; - display:inline-block; - float:left; - background-color:rgb(248, 152, 29); - border:none; - height:15px; - font-size:14px; -} -.memberSummary caption span.activeTableTab span, .packagesSummary caption span.activeTableTab span, -.overviewSummary caption span.activeTableTab span, .typeSummary caption span.activeTableTab span { - white-space:nowrap; - padding-top:5px; - padding-bottom:8px; - padding-left:12px; - padding-right:12px; - display:inline-block; - float:left; - background-color:rgb(248, 152, 29); - border:none; - height:15px; - font-size:14px; -} -.memberSummary caption span.tableTab span, .packagesSummary caption span.tableTab span, -.overviewSummary caption span.tableTab span, .typeSummary caption span.tableTab span { - white-space:nowrap; - padding-top:5px; - padding-left:12px; - padding-right:12px; - margin-right:3px; - display:inline-block; - float:left; - background-color:rgb(89, 102, 108); - height:15px; -} -.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab, -.packagesSummary caption span.tableTab, .packagesSummary caption span.activeTableTab, -.overviewSummary caption span.tableTab, .overviewSummary caption span.activeTableTab, -.typeSummary caption span.tableTab, .typeSummary caption span.activeTableTab { - padding-top:0px; - padding-left:0px; - padding-right:0px; - background-image:none; - float:none; - display:inline; -} -.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, -.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd, -.requiresSummary .tabEnd, .packagesSummary .tabEnd, .providesSummary .tabEnd, .usesSummary .tabEnd { - display:none; - width:5px; - position:relative; - float:left; - background-color:rgb(248, 152, 29); -} -.memberSummary .activeTableTab .tabEnd, .packagesSummary .activeTableTab .tabEnd, -.overviewSummary .activeTableTab .tabEnd, .typeSummary .activeTableTab .tabEnd { - display:none; - width:5px; - margin-right:3px; - position:relative; - float:left; - background-color:rgb(248, 152, 29); -} -.memberSummary .tableTab .tabEnd, .packagesSummary .tableTab .tabEnd, -.overviewSummary .tableTab .tabEnd, .typeSummary .tableTab .tabEnd { - display:none; - width:5px; - margin-right:3px; - position:relative; - background-color:rgb(89, 102, 108); - float:left; -} -.rowColor th, .altColor th { - font-weight:normal; -} -.overviewSummary td, .memberSummary td, .typeSummary td, -.useSummary td, .constantsSummary td, .deprecatedSummary td, -.requiresSummary td, .packagesSummary td, .providesSummary td, .usesSummary td { - text-align:left; - padding:0px 0px 12px 10px; -} -th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .useSummary th, -.constantsSummary th, .packagesSummary th, td.colFirst, td.colSecond, td.colLast, .useSummary td, -.constantsSummary td { - vertical-align:top; - padding-right:0px; - padding-top:5px; - padding-bottom:5px; -} -th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .constantsSummary th, -.packagesSummary th { - background:rgb(188, 174, 121, 0.5); - text-align:left; - padding-top:5px; - padding-bottom:5px; - padding-left:10px; -} -td.colFirst, th.colFirst { - font-size:13px; -} -td.colSecond, th.colSecond, td.colLast, th.colConstructorName, th.colDeprecatedItemName, th.colLast { - font-size:13px; -} -.constantsSummary th, .packagesSummary th { - font-size:13px; -} -.providesSummary th.colFirst, .providesSummary th.colLast, .providesSummary td.colFirst, -.providesSummary td.colLast { - white-space:normal; - font-size:13px; -} -.overviewSummary td.colFirst, .overviewSummary th.colFirst, -.requiresSummary td.colFirst, .requiresSummary th.colFirst, -.packagesSummary td.colFirst, .packagesSummary td.colSecond, .packagesSummary th.colFirst, .packagesSummary th, -.usesSummary td.colFirst, .usesSummary th.colFirst, -.providesSummary td.colFirst, .providesSummary th.colFirst, -.memberSummary td.colFirst, .memberSummary th.colFirst, -.memberSummary td.colSecond, .memberSummary th.colSecond, .memberSummary th.colConstructorName, -.typeSummary td.colFirst, .typeSummary th.colFirst { - vertical-align:top; -} -.packagesSummary th.colLast, .packagesSummary td.colLast { - white-space:normal; -} -td.colFirst a:link, td.colFirst a:visited, -td.colSecond a:link, td.colSecond a:visited, -th.colFirst a:link, th.colFirst a:visited, -th.colSecond a:link, th.colSecond a:visited, -th.colConstructorName a:link, th.colConstructorName a:visited, -th.colDeprecatedItemName a:link, th.colDeprecatedItemName a:visited, -.constantValuesContainer td a:link, .constantValuesContainer td a:visited, -.allClassesContainer td a:link, .allClassesContainer td a:visited, -.allPackagesContainer td a:link, .allPackagesContainer td a:visited { - font-weight:bold; -} -.tableSubHeadingColor { - background-color:#EEEEFF; -} -.altColor, .altColor th { - background-color:#FFFFFF; -} -.rowColor, .rowColor th { - background-color:#EEEEEF; -} -/* - * Styles for contents. - */ -.description pre { - margin-top:0; -} -.deprecatedContent { - margin:0; - padding:10px 0; -} -.docSummary { - padding:0; -} -ul.blockList ul.blockList ul.blockList li.blockList h3 { - font-style:normal; -} -div.block { - font-size:15px; - font-family:Lato, 'DejaVu Serif', Georgia, "Times New Roman", Times, serif; -} -td.colLast div { - padding-top:0px; -} -td.colLast a { - padding-bottom:3px; -} -/* - * Styles for formatting effect. - */ -.sourceLineNo { - color:green; - padding:0 30px 0 0; -} -h1.hidden { - visibility:hidden; - overflow:hidden; - font-size:10px; -} -.block { - display:block; - margin:3px 10px 2px 0px; - color:#474747; -} -.deprecatedLabel, .descfrmTypeLabel, .implementationLabel, .memberNameLabel, .memberNameLink, -.moduleLabelInPackage, .moduleLabelInType, .overrideSpecifyLabel, .packageLabelInType, -.packageHierarchyLabel, .paramLabel, .returnLabel, .seeLabel, .simpleTagLabel, -.throwsLabel, .typeNameLabel, .typeNameLink, .searchTagLink { - font-weight:bold; -} -.deprecationComment, .emphasizedPhrase, .interfaceName { - font-style:italic; -} -.deprecationBlock { - font-size:15px; - font-family:Lato, 'DejaVu Serif', Georgia, "Times New Roman", Times, serif; - border-style:solid; - border-width:thin; - //border-radius:10px; - padding:10px; - margin-bottom:10px; - margin-right:10px; - display:inline-block; -} -div.block div.deprecationComment, div.block div.block span.emphasizedPhrase, -div.block div.block span.interfaceName { - font-style:normal; -} -div.contentContainer ul.blockList li.blockList h2 { - padding-bottom:0px; -} -/* - * Styles for IFRAME. - */ -.mainContainer { - margin:0 auto; - padding:0; - height:100%; - width:100%; - position:fixed; - top:0; - left:0; -} -.leftContainer { - height:100%; - position:fixed; - width:320px; -} -.leftTop { - position:relative; - float:left; - width:315px; - top:0; - left:0; - height:30%; - border-right:6px solid #ccc; - border-bottom:6px solid #ccc; -} -.leftBottom { - position:relative; - float:left; - width:315px; - bottom:0; - left:0; - height:70%; - border-right:6px solid #ccc; - border-top:1px solid #000; -} -.rightContainer { - position:absolute; - left:320px; - top:0; - bottom:0; - height:100%; - right:0; - border-left:1px solid #000; -} -.rightIframe { - margin:0; - padding:0; - height:100%; - right:30px; - width:100%; - overflow:visible; - margin-bottom:30px; -} -/* - * Styles specific to HTML5 elements. - */ -main, nav, header, footer, section { - display:block; -} -/* - * Styles for javadoc search. - */ -.ui-autocomplete-category { - font-weight:bold; - font-size:15px; - padding:7px 0 7px 3px; - background-color:rgb(89, 102, 108); - color:#FFFFFF; -} -.resultItem { - font-size:13px; -} -.ui-autocomplete { - max-height:85%; - max-width:65%; - overflow-y:scroll; - overflow-x:scroll; - white-space:nowrap; - box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23); -} -ul.ui-autocomplete { - position:fixed; - z-index:999999; - background-color: #FFFFFF; -} -ul.ui-autocomplete li { - float:left; - clear:both; - width:100%; -} -.resultHighlight { - font-weight:bold; -} -.ui-autocomplete .result-item { - font-size: inherit; -} -#search { - background-image:url('resources/glass.png'); - background-size:13px; - background-repeat:no-repeat; - background-position:2px 3px; - padding-left:20px; - position:relative; - right:-18px; -} -#reset { - background-color: rgb(255,255,255); - background-image:url('resources/x.png'); - background-position:center; - background-repeat:no-repeat; - background-size:12px; - border:0 none; - width:15px; - height:17px; - position:relative; - left:-4px; - top:-4px; - font-size:0px; -} -.watermark { - color:#545454; -} -.searchTagDescResult { - font-style:italic; - font-size:11px; -} -.searchTagHolderResult { - font-style:italic; - font-size:12px; -} -.searchTagResult:before, .searchTagResult:target { - color:red; -} -.moduleGraph span { - display:none; - position:absolute; -} -.moduleGraph:hover span { - display:block; - margin: -100px 0 0 100px; - z-index: 1; -} -.methodSignature { - white-space:normal; -} - -/* - * Styles for user-provided tables. - * - * borderless: - * No borders, vertical margins, styled caption. - * This style is provided for use with existing doc comments. - * In general, borderless tables should not be used for layout purposes. - * - * plain: - * Plain borders around table and cells, vertical margins, styled caption. - * Best for small tables or for complex tables for tables with cells that span - * rows and columns, when the "striped" style does not work well. - * - * striped: - * Borders around the table and vertical borders between cells, striped rows, - * vertical margins, styled caption. - * Best for tables that have a header row, and a body containing a series of simple rows. - */ - -table.borderless, -table.plain, -table.striped { - margin-top: 10px; - margin-bottom: 10px; -} -table.borderless > caption, -table.plain > caption, -table.striped > caption { - font-weight: bold; - font-size: smaller; -} -table.borderless th, table.borderless td, -table.plain th, table.plain td, -table.striped th, table.striped td { - padding: 2px 5px; -} -table.borderless, -table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th, -table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td { - border: none; -} -table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr { - background-color: transparent; -} -table.plain { - border-collapse: collapse; - border: 1px solid black; -} -table.plain > thead > tr, table.plain > tbody tr, table.plain > tr { - background-color: transparent; -} -table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th, -table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td { - border: 1px solid black; -} -table.striped { - border-collapse: collapse; - border: 1px solid black; -} -table.striped > thead { - background-color: #E3E3E3; -} -table.striped > thead > tr > th, table.striped > thead > tr > td { - border: 1px solid black; -} -table.striped > tbody > tr:nth-child(even) { - background-color: #EEE -} -table.striped > tbody > tr:nth-child(odd) { - background-color: #FFF -} -table.striped > tbody > tr > th, table.striped > tbody > tr > td { - border-left: 1px solid black; - border-right: 1px solid black; -} -table.striped > tbody > tr > th { - font-weight: normal; -} -.ui-widget { - font-family: Lato!important; - font-size:14px; -} \ No newline at end of file diff --git a/documentation/src/main/javadoc/overview.html b/shared/javadoc/overview.html similarity index 100% rename from documentation/src/main/javadoc/overview.html rename to shared/javadoc/overview.html diff --git a/documentation/src/main/javadoc/stylesheet.css b/shared/javadoc/stylesheet.css similarity index 100% rename from documentation/src/main/javadoc/stylesheet.css rename to shared/javadoc/stylesheet.css diff --git a/tooling/hibernate-gradle-plugin/hibernate-gradle-plugin.gradle b/tooling/hibernate-gradle-plugin/hibernate-gradle-plugin.gradle index 7bd04c1703..5518207697 100644 --- a/tooling/hibernate-gradle-plugin/hibernate-gradle-plugin.gradle +++ b/tooling/hibernate-gradle-plugin/hibernate-gradle-plugin.gradle @@ -136,6 +136,13 @@ else { " Using the JDK that runs Gradle for Groovy compilation." ) } +tasks.named( "javadoc", Javadoc ) { + configure( options ) { + windowTitle = "Hibernate Javadocs ($project.name)" + docTitle = "Hibernate Javadocs ($project.name : $project.version)" + } +} + checkstyle { sourceSets = [ project.sourceSets.main ] configFile = rootProject.file( 'shared/config/checkstyle/checkstyle.xml' )