org.codice.ddf.migration

Class MigrationInformation

java.lang.Object

org.codice.ddf.migration.MigrationInformation

All Implemented Interfaces:

MigrationMessage

Direct Known Subclasses:

MigrationSuccessfulInformation

public class MigrationInformation
extends Object
implements MigrationMessage

Class that provides information status for migration operations.

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.

Constructor Summary

Constructors

Constructor and Description
MigrationInformation(String message) Constructs a new migration informational message with the specified detail message.
MigrationInformation(String format, Object... args) Constructs a new migration informational message with the specified detail message to be formatted with the specified parameters.

Method Summary

Modifier and Type	Method and Description
String	getMessage() Gets the string representation for this migration message.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MigrationInformation

public MigrationInformation(String message)

Constructs a new migration informational message 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 informational message

Throws:

IllegalArgumentException - if message is null

MigrationInformation

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

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

Parameters:

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

args - the arguments to the format message

Throws:

IllegalArgumentException - if format is null

Method Detail

getMessage

public String getMessage()

Description copied from interface: MigrationMessage

Gets the string representation for this migration message.

Specified by:

getMessage in interface MigrationMessage

Returns:

the message string representation

toString

public String toString()

Overrides:

toString in class Object