ome.smuggler.web

Class Error

java.lang.Object

ome.smuggler.web.Error

public class Error
extends java.lang.Object

Web clients receive instances of this class if their request results in an error. This is just a data transfer object whose sole purpose is to facilitate the transfer of information from the client to the server.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	reason Details what went wrong.

Constructor Summary

Constructors

Constructor and Description
Error() Empty constructor for (de-)serialisation.
Error(java.lang.String reason) Convenience constructor to set the reason for the error.

Method Summary

Modifier and Type	Method and Description
static <R> util.object.Either<Error,R>	error(java.lang.String reason) Utility method to create a left Either with an Error.

Methods inherited from class java.lang.Object

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

Field Detail

reason

public java.lang.String reason

Details what went wrong.

Constructor Detail

Error

public Error()

Empty constructor for (de-)serialisation.

Error

public Error(java.lang.String reason)

Convenience constructor to set the reason for the error.

Parameters:

reason - what went wrong.

Method Detail

error

public static <R> util.object.Either<Error,R> error(java.lang.String reason)

Utility method to create a left Either with an Error.

Type Parameters:

R - any type.

Parameters:

reason - the reason to set in the returned error.

Returns:

a left Either with an Error having the specified reason.