com.gemstone.gemfire.internal.cache.tier.BatchException Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gemfire-core Show documentation

SnappyData store based off Pivotal GemFireXD

The newest version!

/*
 * Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
 *
 * 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. See accompanying
 * LICENSE file.
 */

package com.gemstone.gemfire.internal.cache.tier;

import com.gemstone.gemfire.GemFireCheckedException;
/**
 * An exception thrown during batch processing.
 *
 * @author Barry Oglesby
 *
 * @since 4.2
 */
// Note that since this class is inside of an internal package,
// we make it extend Exception, thereby making it a checked exception.
public class BatchException extends GemFireCheckedException {
private static final long serialVersionUID = -6707074107791305564L;

  protected int _index;

  /**
   * Required for serialization
   */
  public  BatchException() {
  }

  /**
   * Constructor.
   * Creates an instance of RegionQueueException with the
   * specified detail message.
   * @param msg the detail message
   * @param index the index in the batch list where the exception occurred
   */
  public BatchException(String msg, int index) {
    super(msg);
    this._index = index;
  }

  /**
   * Constructor.
   * Creates an instance of RegionQueueException with the
   * specified cause.
   * @param cause the causal Throwable
   * @param index the index in the batch list where the exception occurred
   */
  public BatchException(Throwable cause, int index) {
    super(cause);
    this._index = index;
  }

  /**
   * Answers the index in the batch where the exception occurred
   * @return the index in the batch where the exception occurred
   */
  public int getIndex() {
    return this._index;
  }
}