Open Source Repository

Home /spring/spring-transaction-3.0.5 | Repository Home



org/springframework/dao/IncorrectResultSizeDataAccessException.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.dao;

/**
 * Data access exception thrown when a result was not of the expected size,
 * for example when expecting a single row but getting 0 or more than 1 rows.
 *
 @author Juergen Hoeller
 @since 1.0.2
 @see EmptyResultDataAccessException
 */
public class IncorrectResultSizeDataAccessException extends DataRetrievalFailureException {

  private int expectedSize;

  private int actualSize;


  /**
   * Constructor for IncorrectResultSizeDataAccessException.
   @param expectedSize the expected result size
   */
  public IncorrectResultSizeDataAccessException(int expectedSize) {
    super("Incorrect result size: expected " + expectedSize);
    this.expectedSize = expectedSize;
    this.actualSize = -1;
  }

  /**
   * Constructor for IncorrectResultSizeDataAccessException.
   @param expectedSize the expected result size
   @param actualSize the actual result size (or -1 if unknown)
   */
  public IncorrectResultSizeDataAccessException(int expectedSize, int actualSize) {
    super("Incorrect result size: expected " + expectedSize + ", actual " + actualSize);
    this.expectedSize = expectedSize;
    this.actualSize = actualSize;
  }

  /**
   * Constructor for IncorrectResultSizeDataAccessException.
   @param msg the detail message
   @param expectedSize the expected result size
   */
  public IncorrectResultSizeDataAccessException(String msg, int expectedSize) {
    super(msg);
    this.expectedSize = expectedSize;
    this.actualSize = -1;
  }

  /**
   * Constructor for IncorrectResultSizeDataAccessException.
   @param msg the detail message
   @param expectedSize the expected result size
   @param actualSize the actual result size (or -1 if unknown)
   */
  public IncorrectResultSizeDataAccessException(String msg, int expectedSize, int actualSize) {
    super(msg);
    this.expectedSize = expectedSize;
    this.actualSize = actualSize;
  }


  /**
   * Return the expected result size.
   */
  public int getExpectedSize() {
    return expectedSize;
  }

  /**
   * Return the actual result size (or -1 if unknown).
   */
  public int getActualSize() {
    return actualSize;
  }

}