Package com.io7m.smfj.processing.api
Class SMFProcessingError
- java.lang.Object
-
- com.io7m.smfj.processing.api.SMFProcessingError
-
- All Implemented Interfaces:
SMFErrorType
,SMFProcessingErrorType
public final class SMFProcessingError extends java.lang.Object implements SMFProcessingErrorType
The type of processing errors.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SMFProcessingError.Builder
Builds instances of typeSMFProcessingError
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SMFProcessingError.Builder
builder()
Creates a builder forSMFProcessingError
.static SMFProcessingError
copyOf(SMFProcessingErrorType instance)
Creates an immutable copy of aSMFProcessingErrorType
value.boolean
equals(java.lang.Object another)
This instance is equal to all instances ofSMFProcessingError
that have equal attribute values.java.util.Optional<java.lang.Exception>
exception()
java.lang.String
fullMessage()
int
hashCode()
Computes a hash code from attributes:message
,exception
.java.lang.String
message()
static SMFProcessingError
of(java.lang.String message, java.util.Optional<? extends java.lang.Exception> exception)
Construct a new immutableSMFProcessingError
instance.java.lang.String
toString()
Prints the immutable valueSMFProcessingError
with attribute values.SMFProcessingError
withException(java.lang.Exception value)
Copy the current immutable object by setting a present value for the optionalexception
attribute.SMFProcessingError
withException(java.util.Optional<? extends java.lang.Exception> optional)
Copy the current immutable object by setting an optional value for theexception
attribute.SMFProcessingError
withMessage(java.lang.String value)
Copy the current immutable object by setting a value for themessage
attribute.
-
-
-
Method Detail
-
message
public java.lang.String message()
- Specified by:
message
in interfaceSMFErrorType
- Specified by:
message
in interfaceSMFProcessingErrorType
- Returns:
- The value of the
message
attribute
-
exception
public java.util.Optional<java.lang.Exception> exception()
- Specified by:
exception
in interfaceSMFErrorType
- Specified by:
exception
in interfaceSMFProcessingErrorType
- Returns:
- The value of the
exception
attribute
-
withMessage
public final SMFProcessingError withMessage(java.lang.String value)
Copy the current immutable object by setting a value for themessage
attribute. An equals check used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for message- Returns:
- A modified copy of the
this
object
-
withException
public final SMFProcessingError withException(java.lang.Exception value)
Copy the current immutable object by setting a present value for the optionalexception
attribute.- Parameters:
value
- The value for exception- Returns:
- A modified copy of
this
object
-
withException
public final SMFProcessingError withException(java.util.Optional<? extends java.lang.Exception> optional)
Copy the current immutable object by setting an optional value for theexception
attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis
.- Parameters:
optional
- A value for exception- Returns:
- A modified copy of
this
object
-
equals
public boolean equals(java.lang.Object another)
This instance is equal to all instances ofSMFProcessingError
that have equal attribute values.- Overrides:
equals
in classjava.lang.Object
- Returns:
true
ifthis
is equal toanother
instance
-
hashCode
public int hashCode()
Computes a hash code from attributes:message
,exception
.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- hashCode value
-
toString
public java.lang.String toString()
Prints the immutable valueSMFProcessingError
with attribute values.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of the value
-
fullMessage
public java.lang.String fullMessage()
Returns a lazily initialized value of the
fullMessage
attribute. Initialized once and only once and stored for subsequent access with proper synchronization. In case of any exception or error thrown by the lazy value initializer, the result will not be memoised (i.e. remembered) and on next call computation will be attempted again.- Specified by:
fullMessage
in interfaceSMFErrorType
- Returns:
- A lazily initialized value of the
fullMessage
attribute
-
of
public static SMFProcessingError of(java.lang.String message, java.util.Optional<? extends java.lang.Exception> exception)
Construct a new immutableSMFProcessingError
instance.- Parameters:
message
- The value for themessage
attributeexception
- The value for theexception
attribute- Returns:
- An immutable SMFProcessingError instance
-
copyOf
public static SMFProcessingError copyOf(SMFProcessingErrorType instance)
Creates an immutable copy of aSMFProcessingErrorType
value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.- Parameters:
instance
- The instance to copy- Returns:
- A copied immutable SMFProcessingError instance
-
builder
public static SMFProcessingError.Builder builder()
Creates a builder forSMFProcessingError
.SMFProcessingError.builder() .setMessage(String) // required
message
.setException(Exception) // optionalexception
.build();- Returns:
- A new SMFProcessingError builder
-
-