Open Source Repository

Home /hibernate/hibernate-3.2.6.ga | Repository Home


org/hibernate/usertype/LoggableUserType.java
package org.hibernate.usertype;

import org.hibernate.engine.SessionFactoryImplementor;

/**
 * Marker interface for user types which want to perform custom
 * logging of their corresponding values
 *
 @author Steve Ebersole
 */
public interface LoggableUserType {
  /**
   * Generate a loggable string representation of the collection (value).
   *
   @param value The collection to be logged; guarenteed to be non-null and initialized.
   @param factory The factory.
   @return The loggable string representation.
   */
  public String toLoggableString(Object value, SessionFactoryImplementor factory);
}