[hibernate-commits] Hibernate SVN: r11046 - branches/Branch_3_2/Hibernate3/src/org/hibernate/type.
hibernate-commits at lists.jboss.org
hibernate-commits at lists.jboss.org
Tue Jan 16 10:25:55 EST 2007
Author: steve.ebersole at jboss.com
Date: 2007-01-16 10:25:54 -0500 (Tue, 16 Jan 2007)
New Revision: 11046
Modified:
branches/Branch_3_2/Hibernate3/src/org/hibernate/type/NullableType.java
Log:
HHH-2356 : NullableType.toString + nulls;
javadocs;
formatting
Modified: branches/Branch_3_2/Hibernate3/src/org/hibernate/type/NullableType.java
===================================================================
--- branches/Branch_3_2/Hibernate3/src/org/hibernate/type/NullableType.java 2007-01-16 03:27:38 UTC (rev 11045)
+++ branches/Branch_3_2/Hibernate3/src/org/hibernate/type/NullableType.java 2007-01-16 15:25:54 UTC (rev 11046)
@@ -24,28 +24,75 @@
*/
public abstract class NullableType extends AbstractType {
- private static final boolean IS_TRACE_ENABLED;
- static {
- //cache this, because it was a significant performance cost; is
- // trace logging enabled on the type package...
- IS_TRACE_ENABLED = LogFactory.getLog( StringHelper.qualifier( Type.class.getName() ) ).isTraceEnabled();
+ /**
+ * This is the old scheme where logging of parameter bindings and value extractions
+ * was controlled by the trace level enablement on the 'org.hibernate.type' package...
+ * <p/>
+ * Originally was cached such because of performance of looking up the logger each time
+ * in order to check the trace-enablement. Driving this via a central Log-specific class
+ * would alleviate that performance hit, and yet still allow more "normal" logging usage/config..
+ */
+ private static final boolean IS_VALUE_TRACING_ENABLED = LogFactory.getLog( StringHelper.qualifier( Type.class.getName() ) ).isTraceEnabled();
+ private transient Log log;
+
+ private Log log() {
+ if ( log == null ) {
+ log = LogFactory.getLog( getClass() );
+ }
+ return log;
}
/**
* Get a column value from a result set, without worrying about the
- * possibility of null values
+ * possibility of null values. Called from {@link #nullSafeGet} after
+ * nullness checks have been performed.
+ *
+ * @param rs The result set from which to extract the value.
+ * @param name The name of the value to extract.
+ *
+ * @return The extracted value.
+ *
+ * @throws org.hibernate.HibernateException Generally some form of mismatch error.
+ * @throws java.sql.SQLException Indicates problem making the JDBC call(s).
*/
- public abstract Object get(ResultSet rs, String name)
- throws HibernateException, SQLException;
+ public abstract Object get(ResultSet rs, String name) throws HibernateException, SQLException;
/**
- * Get a parameter value without worrying about the possibility of null values
+ * Set a parameter value without worrying about the possibility of null
+ * values. Called from {@link #nullSafeSet} after nullness checks have
+ * been performed.
+ *
+ * @param st The statement into which to bind the parameter value.
+ * @param value The parameter value to bind.
+ * @param index The position or index at which to bind the param value.
+ *
+ * @throws org.hibernate.HibernateException Generally some form of mismatch error.
+ * @throws java.sql.SQLException Indicates problem making the JDBC call(s).
*/
- public abstract void set(PreparedStatement st, Object value, int index)
- throws HibernateException, SQLException;
+ public abstract void set(PreparedStatement st, Object value, int index) throws HibernateException, SQLException;
+ /**
+ * A convenience form of {@link #sqlTypes(org.hibernate.engine.Mapping)}, returning
+ * just a single type value since these are explicitly dealing with single column
+ * mappings.
+ *
+ * @return The {@link java.sql.Types} mapping value.
+ */
public abstract int sqlType();
+ /**
+ * A null-safe version of {@link #toString(Object)}. Specifically we are
+ * worried about null safeness in regards to the incoming value parameter,
+ * not the return.
+ *
+ * @param value The value to convert to a string representation; may be null.
+ * @return The string representation; may be null.
+ * @throws HibernateException Thrown by {@link #toString(Object)}, which this calls.
+ */
+ public String nullSafeToString(Object value) throws HibernateException {
+ return value == null ? null : toString( value );
+ }
+
public abstract String toString(Object value) throws HibernateException;
public abstract Object fromStringValue(String xml) throws HibernateException;
@@ -55,28 +102,34 @@
Object value,
int index,
boolean[] settable,
- SessionImplementor session)
- throws HibernateException, SQLException {
- if ( settable[0] ) nullSafeSet(st, value, index);
+ SessionImplementor session) throws HibernateException, SQLException {
+ if ( settable[0] ) {
+ nullSafeSet(st, value, index);
+ }
}
- public final void nullSafeSet(PreparedStatement st, Object value, int index, SessionImplementor session)
- throws HibernateException, SQLException {
+ public final void nullSafeSet(
+ PreparedStatement st,
+ Object value,
+ int index,
+ SessionImplementor session) throws HibernateException, SQLException {
nullSafeSet(st, value, index);
}
- public final void nullSafeSet(PreparedStatement st, Object value, int index)
- throws HibernateException, SQLException {
+ public final void nullSafeSet(
+ PreparedStatement st,
+ Object value,
+ int index) throws HibernateException, SQLException {
try {
if ( value == null ) {
- if ( IS_TRACE_ENABLED ) {
+ if ( IS_VALUE_TRACING_ENABLED ) {
log().trace( "binding null to parameter: " + index );
}
st.setNull( index, sqlType() );
}
else {
- if ( IS_TRACE_ENABLED ) {
+ if ( IS_VALUE_TRACING_ENABLED ) {
log().trace( "binding '" + toString( value ) + "' to parameter: " + index );
}
@@ -84,11 +137,11 @@
}
}
catch ( RuntimeException re ) {
- log().info( "could not bind value '" + toString( value ) + "' to parameter: " + index + "; " + re.getMessage() );
+ log().info( "could not bind value '" + nullSafeToString( value ) + "' to parameter: " + index + "; " + re.getMessage() );
throw re;
}
catch ( SQLException se ) {
- log().info( "could not bind value '" + toString( value ) + "' to parameter: " + index + "; " + se.getMessage() );
+ log().info( "could not bind value '" + nullSafeToString( value ) + "' to parameter: " + index + "; " + se.getMessage() );
throw se;
}
}
@@ -97,28 +150,25 @@
ResultSet rs,
String[] names,
SessionImplementor session,
- Object owner)
- throws HibernateException, SQLException {
+ Object owner) throws HibernateException, SQLException {
return nullSafeGet(rs, names[0]);
}
- public final Object nullSafeGet(ResultSet rs, String[] names)
- throws HibernateException, SQLException {
+ public final Object nullSafeGet(ResultSet rs, String[] names) throws HibernateException, SQLException {
return nullSafeGet(rs, names[0]);
}
- public final Object nullSafeGet(ResultSet rs, String name)
- throws HibernateException, SQLException {
+ public final Object nullSafeGet(ResultSet rs, String name) throws HibernateException, SQLException {
try {
Object value = get(rs, name);
if ( value == null || rs.wasNull() ) {
- if ( IS_TRACE_ENABLED ) {
+ if ( IS_VALUE_TRACING_ENABLED ) {
log().trace( "returning null as column: " + name );
}
return null;
}
else {
- if (IS_TRACE_ENABLED) {
+ if ( IS_VALUE_TRACING_ENABLED ) {
log().trace( "returning '" + toString( value ) + "' as column: " + name );
}
return value;
@@ -186,7 +236,4 @@
return checkable[0] && isDirty(old, current, session);
}
- private Log log() {
- return LogFactory.getLog( getClass() );
- }
}
More information about the hibernate-commits
mailing list