Class SPIProbeFailure
java.lang.Object
com.io7m.coffeepick.runtime.parser.spi.SPIProbeFailure
- All Implemented Interfaces:
SPIProbeResultType
,SPIProbeResultType.SPIProbeFailureType
public final class SPIProbeFailure extends java.lang.Object implements SPIProbeResultType.SPIProbeFailureType
Probing failed.
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SPIProbeFailure.Builder
Builds instances of typeSPIProbeFailure
.Nested classes/interfaces inherited from interface com.io7m.coffeepick.runtime.parser.spi.SPIProbeResultType
SPIProbeResultType.Kind, SPIProbeResultType.SPIProbeFailureType, SPIProbeResultType.SPIProbeSuccessType
-
Method Summary
Modifier and Type Method Description static SPIProbeFailure.Builder
builder()
Creates a builder forSPIProbeFailure
.static SPIProbeFailure
copyOf(SPIProbeResultType.SPIProbeFailureType instance)
Creates an immutable copy of aSPIProbeResultType.SPIProbeFailureType
value.boolean
equals(java.lang.Object another)
This instance is equal to all instances ofSPIProbeFailure
that have equal attribute values.java.util.Optional<java.lang.Exception>
error()
int
hashCode()
Computes a hash code from attributes:error
.java.lang.String
toString()
Prints the immutable valueSPIProbeFailure
with attribute values.SPIProbeFailure
withError(java.lang.Exception value)
Copy the current immutable object by setting a present value for the optionalerror
attribute.SPIProbeFailure
withError(java.util.Optional<? extends java.lang.Exception> optional)
Copy the current immutable object by setting an optional value for theerror
attribute.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.io7m.coffeepick.runtime.parser.spi.SPIProbeResultType.SPIProbeFailureType
kind
-
Method Details
-
error
public java.util.Optional<java.lang.Exception> error()- Specified by:
error
in interfaceSPIProbeResultType.SPIProbeFailureType
- Returns:
- The exception encountered, if any
-
withError
Copy the current immutable object by setting a present value for the optionalerror
attribute.- Parameters:
value
- The value for error- Returns:
- A modified copy of
this
object
-
withError
Copy the current immutable object by setting an optional value for theerror
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 error- Returns:
- A modified copy of
this
object
-
equals
public boolean equals(java.lang.Object another)This instance is equal to all instances ofSPIProbeFailure
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:error
.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- hashCode value
-
toString
public java.lang.String toString()Prints the immutable valueSPIProbeFailure
with attribute values.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of the value
-
copyOf
Creates an immutable copy of aSPIProbeResultType.SPIProbeFailureType
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 SPIProbeFailure instance
-
builder
Creates a builder forSPIProbeFailure
.SPIProbeFailure.builder() .setError(Exception) // optional
error
.build();- Returns:
- A new SPIProbeFailure builder
-