Skip to content

Commit 4b45aaa

Browse files
committed
add javadoc
1 parent 330736c commit 4b45aaa

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

hibernate-core/src/main/java/org/hibernate/cfg/Configuration.java

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -404,34 +404,68 @@ public Configuration configure(File configFile) throws HibernateException {
404404

405405
// New typed property setters ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
406406

407+
/**
408+
* Set {@value AvailableSettings#SHOW_SQL}, {@value AvailableSettings#FORMAT_SQL},
409+
* and {@value AvailableSettings#HIGHLIGHT_SQL}.
410+
*
411+
* @param showSql should SQL be logged to console?
412+
* @param formatSql should logged SQL be formatted
413+
* @param highlightSql should logged SQL be highlighted with pretty colors
414+
*/
407415
public Configuration showSql(boolean showSql, boolean formatSql, boolean highlightSql) {
408416
setProperty( AvailableSettings.SHOW_SQL, Boolean.toString(showSql) );
409417
setProperty( AvailableSettings.FORMAT_SQL, Boolean.toString(formatSql) );
410418
setProperty( AvailableSettings.HIGHLIGHT_SQL, Boolean.toString(highlightSql) );
411419
return this;
412420
}
413421

422+
/**
423+
* Set {@value AvailableSettings#HBM2DDL_AUTO}.
424+
*
425+
* @param action the {@link Action}
426+
*/
414427
public Configuration setSchemaExportAction(Action action) {
415428
setProperty( AvailableSettings.HBM2DDL_AUTO, action.getExternalHbm2ddlName() );
416429
return this;
417430
}
418431

432+
/**
433+
* Set {@value AvailableSettings#USER} and {@value AvailableSettings#PASS}.
434+
*
435+
* @param user the user id
436+
* @param pass the password
437+
*/
419438
public Configuration setCredentials(String user, String pass) {
420439
setProperty( AvailableSettings.USER, user );
421440
setProperty( AvailableSettings.PASS, pass );
422441
return this;
423442
}
424443

444+
/**
445+
* Set {@value AvailableSettings#URL}.
446+
*
447+
* @param url the JDBC URL
448+
*/
425449
public Configuration setJdbcUrl(String url) {
426450
setProperty( AvailableSettings.URL, url );
427451
return this;
428452
}
429453

454+
/**
455+
* Set {@value AvailableSettings#DATASOURCE}.
456+
*
457+
* @param jndiName the JNDI name of the datasource
458+
*/
430459
public Configuration setDatasource(String jndiName) {
431460
setProperty( AvailableSettings.DATASOURCE, jndiName );
432461
return this;
433462
}
434463

464+
/**
465+
* Set {@value AvailableSettings#JAKARTA_TRANSACTION_TYPE}.
466+
*
467+
* @param transactionType the {@link PersistenceUnitTransactionType}
468+
*/
435469
public Configuration setTransactionType(PersistenceUnitTransactionType transactionType) {
436470
setProperty( AvailableSettings.JAKARTA_TRANSACTION_TYPE, transactionType.toString() );
437471
return this;

0 commit comments

Comments
 (0)