io.spine.change

Class MessageMismatch

java.lang.Object

io.spine.change.MessageMismatch

public final class MessageMismatch
extends java.lang.Object

Utility class for working with ValueMismatches for Message values.

Method Summary

Modifier and Type	Method and Description
static io.spine.change.ValueMismatch	expectedDefault(com.google.protobuf.Message actual, com.google.protobuf.Message newValue, int version) Creates ValueMismatch for the case of discovering a non-default value, when the default value was expected by a command.
static io.spine.change.ValueMismatch	expectedNotDefault(com.google.protobuf.Message expected, int version) Creates a ValueMismatch for a command that wanted to clear a value, but discovered that the field already has the default value.
static io.spine.change.ValueMismatch	expectedNotDefault(com.google.protobuf.Message expected, com.google.protobuf.Message newValue, int version) Creates a ValueMismatch for a command that wanted to change a field value, but discovered that the field has the default value.
static io.spine.change.ValueMismatch	unexpectedValue(com.google.protobuf.Message expected, com.google.protobuf.Message actual, com.google.protobuf.Message newValue, int version) Creates ValueMismatch for the case of discovering a value different than by a command.
static com.google.protobuf.Message	unpackActual(io.spine.change.ValueMismatch mismatch) Obtains actual value as a Message from the passed mismatch.
static com.google.protobuf.Message	unpackExpected(io.spine.change.ValueMismatch mismatch) Obtains expected value as a Message from the passed mismatch.
static com.google.protobuf.Message	unpackNewValue(io.spine.change.ValueMismatch mismatch) Obtains new value as a Message from the passed mismatch.

Methods inherited from class java.lang.Object

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

Method Detail

expectedDefault

public static io.spine.change.ValueMismatch expectedDefault(com.google.protobuf.Message actual,
                                                            com.google.protobuf.Message newValue,
                                                            int version)

Creates ValueMismatch for the case of discovering a non-default value, when the default value was expected by a command.

Parameters:

actual - the value discovered instead of the default value

newValue - the new value requested in the command

version - the version of the entity in which the mismatch is discovered

Returns:

new ValueMismatch instance

expectedNotDefault

public static io.spine.change.ValueMismatch expectedNotDefault(com.google.protobuf.Message expected,
                                                               int version)

Creates a ValueMismatch for a command that wanted to clear a value, but discovered that the field already has the default value.

Parameters:

expected - the value of the field that the command wanted to clear

version - the version of the entity in which the mismatch is discovered

Returns:

new ValueMismatch instance

expectedNotDefault

public static io.spine.change.ValueMismatch expectedNotDefault(com.google.protobuf.Message expected,
                                                               com.google.protobuf.Message newValue,
                                                               int version)

Creates a ValueMismatch for a command that wanted to change a field value, but discovered that the field has the default value.

Parameters:

expected - the value expected by the command

newValue - the value the command wanted to set

version - the version of the entity in which the mismatch is discovered

Returns:

new ValueMismatch instance

unexpectedValue

public static io.spine.change.ValueMismatch unexpectedValue(com.google.protobuf.Message expected,
                                                            com.google.protobuf.Message actual,
                                                            com.google.protobuf.Message newValue,
                                                            int version)

Creates ValueMismatch for the case of discovering a value different than by a command.

Parameters:

expected - the value expected by the command

actual - the value discovered instead of the expected value

newValue - the new value requested in the command

version - the version of the entity in which the mismatch is discovered

Returns:

new ValueMismatch instance

unpackExpected

public static com.google.protobuf.Message unpackExpected(io.spine.change.ValueMismatch mismatch)

Obtains expected value as a Message from the passed mismatch.

Throws:

java.lang.RuntimeException - if the passed instance represent a mismatch of non-Message values

unpackActual

public static com.google.protobuf.Message unpackActual(io.spine.change.ValueMismatch mismatch)

Obtains actual value as a Message from the passed mismatch.

Throws:

java.lang.RuntimeException - if the passed instance represent a mismatch of non-Message values

unpackNewValue

public static com.google.protobuf.Message unpackNewValue(io.spine.change.ValueMismatch mismatch)

Obtains new value as a Message from the passed mismatch.

Throws:

java.lang.RuntimeException - if the passed instance represent a mismatch of non-Message values