com.github.helenusdriver.driver.UpdateNotAppliedException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
JPA-like syntax for annotating POJO classes for persistence via Cassandra's Java driver - API
The newest version!
/*
 * Copyright (C) 2015-2015 The Helenus Driver Project 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 com.github.helenusdriver.driver;

import com.datastax.driver.core.Row;
import com.datastax.driver.core.exceptions.QueryExecutionException;

/**
 * The UpdateNotAppliedException exception when an "IF" condition
 * is specified on an "UPDATE" request and the update failed to be applied because
 * the conditions were not all met.
 *
 * @copyright 2015-2015 The Helenus Driver Project Authors
 *
 * @author  The Helenus Driver Project Authors
 * @version 1 - Jan 15, 2015 - paouelle - Creation
 *
 * @since 1.0
 */
public class UpdateNotAppliedException extends QueryExecutionException {
  /**
   * Holds the serialVersionUID.
   *
   * @author paouelle
   */
  private static final long serialVersionUID = 6890014464871770725L;

  /**
   * Holds the row holding information about the failed update.
   *
   * @author paouelle
   */
  private final Row row;

  /**
   * Instantiates a new UpdateNotAppliedException object.
   *
   * @author paouelle
   *
   * @param msg the error message
   */
  public UpdateNotAppliedException(String msg) {
    this(null, msg);
  }

  /**
   * Instantiates a new UpdateNotAppliedException object.
   *
   * @author paouelle
   *
   * @param row the result row
   * @param msg the error message
   */
  public UpdateNotAppliedException(Row row, String msg) {
    super(row != null ? msg + "; " + row : msg);
    this.row = row;
  }

  /**
   * Instantiates a new UpdateNotAppliedException object.
   *
   * @author paouelle
   *
   * @param msg the error message
   * @param cause the cause exception
   */
  public UpdateNotAppliedException(String msg, Throwable cause) {
    this(null, msg, cause);
  }

  /**
   * Instantiates a new UpdateNotAppliedException object.
   *
   * @author paouelle
   *
   * @param row the result row
   * @param msg the error message
   * @param cause the cause exception
   */
  public UpdateNotAppliedException(Row row, String msg, Throwable cause) {
    super(row != null ? msg + "; " + row : msg, cause);
    this.row = row;
  }

  /**
   * Gets the result row holding information about the failed update.
   *
   * @author paouelle
   *
   * @return the result row or null if no rows were returned as
   *         part of the result set for the "UPDATE" statement
   */
  public Row getRow() {
    return row;
  }
}