Package com.apple.foundationdb.record
Class LoggableTimeoutException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- java.util.concurrent.TimeoutException
-
- com.apple.foundationdb.record.LoggableTimeoutException
-
- All Implemented Interfaces:
LoggableKeysAndValues<LoggableTimeoutException>
,Serializable
@API(MAINTAINED) public class LoggableTimeoutException extends TimeoutException implements LoggableKeysAndValues<LoggableTimeoutException>
Subclass of TimeoutException with support for adding logging info in the form of keys and values. This enables TimeoutException's to provide context-specific details that can be logged in a way that better supports troubleshooting later.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description LoggableTimeoutException(Throwable cause, Object... keyValues)
Create an exception with the given sequence of key/value pairs.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LoggableTimeoutException
addLogInfo(Object... keyValue)
LoggableTimeoutException
addLogInfo(String description, Object object)
Object[]
exportLogInfo()
Map<String,Object>
getLogInfo()
-
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
-
-
-
-
Constructor Detail
-
LoggableTimeoutException
public LoggableTimeoutException(@Nonnull Throwable cause, @Nullable Object... keyValues)
Create an exception with the given sequence of key/value pairs. This will throw anIllegalArgumentException
ifkeyValues
contains an odd number of elements.- Parameters:
cause
- root cause of the timeout exceptionkeyValues
- loggable keys and values- See Also:
addLogInfo(Object...)
-
-
Method Detail
-
getLogInfo
@Nonnull public Map<String,Object> getLogInfo()
- Specified by:
getLogInfo
in interfaceLoggableKeysAndValues<LoggableTimeoutException>
-
addLogInfo
@Nonnull public LoggableTimeoutException addLogInfo(@Nonnull String description, Object object)
- Specified by:
addLogInfo
in interfaceLoggableKeysAndValues<LoggableTimeoutException>
-
addLogInfo
@Nonnull public LoggableTimeoutException addLogInfo(@Nonnull Object... keyValue)
- Specified by:
addLogInfo
in interfaceLoggableKeysAndValues<LoggableTimeoutException>
-
exportLogInfo
@Nonnull public Object[] exportLogInfo()
- Specified by:
exportLogInfo
in interfaceLoggableKeysAndValues<LoggableTimeoutException>
-
-