Open Source Repository

Home /spring/spring-orm-3.0.5 | Repository Home


org/springframework/orm/ObjectRetrievalFailureException.java
/*
 * Copyright 2002-2006 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.orm;

import org.springframework.dao.DataRetrievalFailureException;

/**
 * Exception thrown if a mapped object could not be retrieved via its identifier.
 * Provides information about the persistent class and the identifier.
 *
 @author Juergen Hoeller
 @since 13.10.2003
 */
public class ObjectRetrievalFailureException extends DataRetrievalFailureException {

  private Object persistentClass;

  private Object identifier;


  /**
   * Create a general ObjectRetrievalFailureException with the given message,
   * without any information on the affected object.
   @param msg the detail message
   @param cause the source exception
   */
  public ObjectRetrievalFailureException(String msg, Throwable cause) {
    super(msg, cause);
  }

  /**
   * Create a new ObjectRetrievalFailureException for the given object,
   * with the default "not found" message.
   @param persistentClass the persistent class
   @param identifier the ID of the object that should have been retrieved
   */
  public ObjectRetrievalFailureException(Class persistentClass, Object identifier) {
    this(persistentClass, identifier,
        "Object of class [" + persistentClass.getName() "] with identifier [" + identifier + "]: not found",
        null);
  }

  /**
   * Create a new ObjectRetrievalFailureException for the given object,
   * with the given explicit message and exception.
   @param persistentClass the persistent class
   @param identifier the ID of the object that should have been retrieved
   @param msg the detail message
   @param cause the source exception
   */
  public ObjectRetrievalFailureException(
      Class persistentClass, Object identifier, String msg, Throwable cause) {

    super(msg, cause);
    this.persistentClass = persistentClass;
    this.identifier = identifier;
  }

  /**
   * Create a new ObjectRetrievalFailureException for the given object,
   * with the default "not found" message.
   @param persistentClassName the name of the persistent class
   @param identifier the ID of the object that should have been retrieved
   */
  public ObjectRetrievalFailureException(String persistentClassName, Object identifier) {
    this(persistentClassName, identifier,
        "Object of class [" + persistentClassName + "] with identifier [" + identifier + "]: not found",
        null);
  }

  /**
   * Create a new ObjectRetrievalFailureException for the given object,
   * with the given explicit message and exception.
   @param persistentClassName the name of the persistent class
   @param identifier the ID of the object that should have been retrieved
   @param msg the detail message
   @param cause the source exception
   */
  public ObjectRetrievalFailureException(
      String persistentClassName, Object identifier, String msg, Throwable cause) {

    super(msg, cause);
    this.persistentClass = persistentClassName;
    this.identifier = identifier;
  }


  /**
   * Return the persistent class of the object that was not found.
   * If no Class was specified, this method returns null.
   */
  public Class getPersistentClass() {
    return (this.persistentClass instanceof Class ? (Classthis.persistentClass : null);
  }

  /**
   * Return the name of the persistent class of the object that was not found.
   * Will work for both Class objects and String names.
   */
  public String getPersistentClassName() {
    if (this.persistentClass instanceof Class) {
      return ((Classthis.persistentClass).getName();
    }
    return (this.persistentClass != null this.persistentClass.toString() null);
  }

  /**
   * Return the identifier of the object that was not found.
   */
  public Object getIdentifier() {
    return identifier;
  }

}