Package aQute.bnd.result
Class Err<V>
java.lang.Object
aQute.bnd.result.Err<V>
- Type Parameters:
V
- The value type
- All Implemented Interfaces:
Result<V>
This class represents the Err side of @{link Result}.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
accept
(ConsumerWithException<? super V> ok, ConsumerWithException<? super String> err) Processes the result.<U> Result<U>
asError()
If anErr
, return this coerced to the desired generic type.error()
Returns the error of this instance as anOptional
.<U> Result<U>
flatMap
(FunctionWithException<? super V, ? extends Result<? extends U>> mapper) FlatMap the contained value if this is anOk
value.boolean
isErr()
boolean
isOk()
<U> Result<U>
map
(FunctionWithException<? super V, ? extends U> mapper) Map the contained value if this is anOk
value.mapErr
(FunctionWithException<? super String, ? extends CharSequence> mapper) Map the contained error if this is anErr
value.Returns the contained value if this is anOk
value.orElseGet
(SupplierWithException<? extends V> orElseSupplier) Returns the contained value if this is anOk
value.orElseThrow
(FunctionWithException<? super String, ? extends R> throwableSupplier) Returns the contained value if this is anOk
value.recover
(FunctionWithException<? super String, ? extends V> recover) Recover the contained error if this is anErr
value.recoverWith
(FunctionWithException<? super String, ? extends Result<? extends V>> recover) Recover the contained error if this is anErr
value.toString()
unwrap()
Returns the contained value if this is anOk
value.unwrap
(CharSequence message) Express the expectation that this object is anOk
value.value()
Returns the value of this instance as anOptional
.
-
Field Details
-
error
-
-
Constructor Details
-
Err
Err(CharSequence error)
-
-
Method Details
-
isOk
public boolean isOk() -
isErr
public boolean isErr() -
value
-
error
-
unwrap
Returns the contained value if this is anOk
value. Otherwise throws aResultException
. -
unwrap
Express the expectation that this object is anOk
value. Otherwise throws aResultException
with the specified message.- Specified by:
unwrap
in interfaceResult<V>
- Parameters:
message
- The message to pass to a potential ResultException. Must not benull
.- Throws:
ResultException
- If this is anErr
instance.
-
orElse
Returns the contained value if this is anOk
value. Otherwise returns the specified alternate value. -
orElseGet
Returns the contained value if this is anOk
value. Otherwise returns the alternate value supplied by the specified supplier. -
orElseThrow
public <R extends Throwable> V orElseThrow(FunctionWithException<? super String, ? extends R> throwableSupplier) throws RReturns the contained value if this is anOk
value. Otherwise throws the exception supplied by the specified function.- Specified by:
orElseThrow
in interfaceResult<V>
- Type Parameters:
R
- The exception type.- Parameters:
throwableSupplier
- The supplier to supply an exception if this is anErr
instance. Must not benull
. The supplier must return a non-null
result.- Returns:
- The contained value.
- Throws:
R
- The exception returned by the throwableSupplier if this is anErr
instance.
-
map
Map the contained value if this is anOk
value. Otherwise return this. -
mapErr
Map the contained error if this is anErr
value. Otherwise return this. -
flatMap
FlatMap the contained value if this is anOk
value. Otherwise return this.- Specified by:
flatMap
in interfaceResult<V>
- Type Parameters:
U
- The new value type.- Parameters:
mapper
- The function to flatmap the contained value into a new result. Must not benull
. The function must return a non-null
result.- Returns:
- The flatmapped result if this is an
Ok
value. Otherwise this.
-
recover
Recover the contained error if this is anErr
value. Otherwise return this.To recover with a recovery value of
null
, theResult.recoverWith(FunctionWithException)
method must be used. The specified function forResult.recoverWith(FunctionWithException)
can returnResult.ok(null)
to supply the desirednull
value.- Specified by:
recover
in interfaceResult<V>
- Parameters:
recover
- The function to recover the contained error into a new value. Must not benull
.- Returns:
- A result containing the new non-
null
value if this is anErr
value. Otherwise this if this is anOk
value or the recover function returnednull
.
-
recoverWith
public Result<V> recoverWith(FunctionWithException<? super String, ? extends Result<? extends V>> recover) Recover the contained error if this is anErr
value. Otherwise return this.- Specified by:
recoverWith
in interfaceResult<V>
- Parameters:
recover
- The function to recover the contained error into a new result. Must not benull
. The function must return a non-null
value.- Returns:
- A result if this is an
Err
value. Otherwise this.
-
accept
Processes the result. -
asError
If anErr
, return this coerced to the desired generic type. -
toString
-