org.codice.ddf.migration

Class MigrationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.codice.ddf.migration.MigrationException

All Implemented Interfaces:

Serializable, MigrationMessage

public class MigrationException
extends RuntimeException
implements MigrationMessage

Exception that indicates some problem with the migration operation.

Note: Detail messages are displayed to the administrator on the console during a migration operation.

This code is experimental. While this class is functional and tested, it may change or be removed in a future version of the library.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MigrationException(MigrationException error)
	MigrationException(String message) Constructs a new migration exception with the specified detail message.
	MigrationException(String format, Object... args) Constructs a new migration exception with the specified detail message to be formatted with the specified parameters.
	MigrationException(String message, Throwable cause) Constructs a new migration exception with the specified detail message and cause.

Method Summary

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.codice.ddf.migration.MigrationMessage

getMessage

Constructor Detail

MigrationException

public MigrationException(String message)

Constructs a new migration exception with the specified detail message.

Note: Detail messages are displayed to the administrator on the console during a migration operation.

Parameters:

message - the detail message for this exception

Throws:

IllegalArgumentException - if message is null

MigrationException

public MigrationException(String format,
                          @Nullable
                          Object... args)

Constructs a new migration exception with the specified detail message to be formatted with the specified parameters.

Note: Detail messages are displayed to the administrator on the console during a migration operation. All Throwable arguments are formatted using their Throwable.getMessage() representation.

Parameters:

format - the format string for the detail message for this exception (see String.format(java.lang.String, java.lang.Object...))

args - the arguments to the format message (if the last argument provided is a Throwable it will automatically be initialized as the cause for the exception)

Throws:

IllegalArgumentException - if format is null

MigrationException

public MigrationException(String message,
                          @Nullable
                          Throwable cause)

Constructs a new migration exception with the specified detail message and cause.

Note: Detail messages are displayed to the administrator on the console during a migration operation.

Parameters:

message - the detail message for this exception

cause - the cause for this exception

Throws:

IllegalArgumentException - if message is null

MigrationException

protected MigrationException(MigrationException error)