Package com.google.cloud.spanner

Class SpannerExceptionFactory

java.lang.Object

com.google.cloud.spanner.SpannerExceptionFactory

public final class SpannerExceptionFactory
extends Object

A factory for creating instances of SpannerException and its subtypes. All creation of these exceptions is directed through the factory. This ensures that particular types of errors are always expressed as the same concrete exception type. For example, exceptions of type ErrorCode.ABORTED are always represented by AbortedException.

Constructor Summary

Constructors

Constructor	Description
SpannerExceptionFactory()

Method Summary

Modifier and Type	Method	Description
static SpannerException	asSpannerException(Throwable t)	Converts the given Throwable to a SpannerException.
static RuntimeException	causeAsRunTimeException(ExecutionException executionException)
static AbortedDueToConcurrentModificationException	newAbortedDueToConcurrentModificationException(AbortedDueToConcurrentModificationException cause)	Constructs a new AbortedDueToConcurrentModificationException that can be re-thrown for a transaction that had already been aborted, but that the client application tried to use for additional statements.
static AbortedDueToConcurrentModificationException	newAbortedDueToConcurrentModificationException(AbortedException cause)	Constructs a specific aborted exception that should only be thrown by a connection after an internal retry aborted due to concurrent modifications.
static AbortedDueToConcurrentModificationException	newAbortedDueToConcurrentModificationException(AbortedException cause, SpannerException databaseError)	Constructs a specific aborted exception that should only be thrown by a connection after an internal retry aborted because a database call caused an exception that did not happen during the original attempt.
static DmlBatchUpdateCountVerificationFailedException	newDmlBatchUpdateCountVerificationFailedException(long[] expected, long[] actual)	Constructs a specific error that
static SpannerBatchUpdateException	newSpannerBatchUpdateException(ErrorCode code, String message, long[] updateCounts)
static SpannerBatchUpdateException	newSpannerBatchUpdateException(ErrorCode code, String message, long[] updateCounts, XGoogSpannerRequestId reqId)
static SpannerException	newSpannerException(ErrorCode code, String message)
static SpannerException	newSpannerException(ErrorCode code, String message, XGoogSpannerRequestId reqId)
static SpannerException	newSpannerException(ErrorCode code, String message, Throwable cause)
static SpannerException	newSpannerException(ErrorCode code, String message, Throwable cause, XGoogSpannerRequestId reqId)
static SpannerException	newSpannerException(io.grpc.Context context, Throwable cause)
static SpannerException	newSpannerException(io.grpc.Context context, Throwable cause, XGoogSpannerRequestId reqId)	Creates a new exception based on cause.
static SpannerException	newSpannerException(Throwable cause)	Creates a new exception based on cause.
static SpannerException	newSpannerException(Throwable cause, XGoogSpannerRequestId reqId)
static SpannerException	propagateInterrupt(InterruptedException e)
static SpannerException	propagateInterrupt(InterruptedException e, XGoogSpannerRequestId reqId)
static SpannerException	propagateTimeout(TimeoutException e)	Transforms a TimeoutException to a SpannerException.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SpannerExceptionFactory

public SpannerExceptionFactory()

Method Details

newSpannerException

public static SpannerException newSpannerException(ErrorCode code,
 @Nullable
 String message)

newSpannerException

public static SpannerException newSpannerException(ErrorCode code,
 @Nullable
 String message,
 @Nullable
 Throwable cause,
 @Nullable
 XGoogSpannerRequestId reqId)

newSpannerException

public static SpannerException newSpannerException(ErrorCode code,
 @Nullable
 String message,
 @Nullable
 XGoogSpannerRequestId reqId)

newSpannerException

public static SpannerException newSpannerException(ErrorCode code,
 @Nullable
 String message,
 @Nullable
 Throwable cause)

propagateInterrupt

public static SpannerException propagateInterrupt(InterruptedException e)

propagateInterrupt

public static SpannerException propagateInterrupt(InterruptedException e,
 XGoogSpannerRequestId reqId)

propagateTimeout

public static SpannerException propagateTimeout(TimeoutException e)

Transforms a TimeoutException to a SpannerException.

 
 try {
   Spanner spanner = SpannerOptions.getDefaultInstance();
   spanner
       .getDatabaseAdminClient()
       .createDatabase("[INSTANCE_ID]", "[DATABASE_ID]", [STATEMENTS])
       .get();
 } catch (TimeoutException e) {
   propagateTimeout(e);
 }
 
 

asSpannerException

public static SpannerException asSpannerException(Throwable t)

Converts the given Throwable to a SpannerException. If t is already a (subclass of a) SpannerException, t is returned unaltered. Otherwise, a new SpannerException is created with t as its cause.

newSpannerException

public static SpannerException newSpannerException(Throwable cause)

Creates a new exception based on cause.

Intended for internal library use; user code should use newSpannerException(ErrorCode, String) instead of this method.

newSpannerException

public static SpannerException newSpannerException(Throwable cause,
 XGoogSpannerRequestId reqId)

newSpannerBatchUpdateException

public static SpannerBatchUpdateException newSpannerBatchUpdateException(ErrorCode code,
 String message,
 long[] updateCounts)

newSpannerBatchUpdateException

public static SpannerBatchUpdateException newSpannerBatchUpdateException(ErrorCode code,
 String message,
 long[] updateCounts,
 @Nullable
 XGoogSpannerRequestId reqId)

newDmlBatchUpdateCountVerificationFailedException

public static DmlBatchUpdateCountVerificationFailedException newDmlBatchUpdateCountVerificationFailedException(long[] expected,
 long[] actual)

Constructs a specific error that

newAbortedDueToConcurrentModificationException

public static AbortedDueToConcurrentModificationException newAbortedDueToConcurrentModificationException(AbortedException cause)

Constructs a specific aborted exception that should only be thrown by a connection after an internal retry aborted due to concurrent modifications.

newAbortedDueToConcurrentModificationException

public static AbortedDueToConcurrentModificationException newAbortedDueToConcurrentModificationException(AbortedException cause,
 SpannerException databaseError)

Constructs a specific aborted exception that should only be thrown by a connection after an internal retry aborted because a database call caused an exception that did not happen during the original attempt.

newAbortedDueToConcurrentModificationException

public static AbortedDueToConcurrentModificationException newAbortedDueToConcurrentModificationException(AbortedDueToConcurrentModificationException cause)

Constructs a new AbortedDueToConcurrentModificationException that can be re-thrown for a transaction that had already been aborted, but that the client application tried to use for additional statements.

newSpannerException

public static SpannerException newSpannerException(@Nullable
 io.grpc.Context context,
 Throwable cause)

newSpannerException

public static SpannerException newSpannerException(@Nullable
 io.grpc.Context context,
 Throwable cause,
 @Nullable
 XGoogSpannerRequestId reqId)

Creates a new exception based on cause. If cause indicates cancellation, context will be inspected to establish the type of cancellation.

Intended for internal library use; user code should use newSpannerException(ErrorCode, String) instead of this method.

causeAsRunTimeException

public static RuntimeException causeAsRunTimeException(ExecutionException executionException)