Package org.apache.jackrabbit.oak.spi.gc
Interface GCMonitor
-
- All Known Implementing Classes:
DelegatingGCMonitor
,GCMonitor.Empty
,GCMonitorTracker
,LoggingGCMonitor
public interface GCMonitor
GCMonitor
instance are used to monitor garbage collection. Instances ofGCMonitor
are registered to theWhiteboard
to receive notifications regarding garbage collection.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
GCMonitor.Empty
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
cleaned(long reclaimedSize, long currentSize)
The cleanup phase of the garbage collection process terminated successfully.void
compacted()
The compaction phase of the garbage collection process terminated successfully.void
error(String message, Exception exception)
An error caused the garbage collection process to terminate prematurely.void
info(String message, Object... arguments)
Informal notification on the progress of garbage collection.void
skipped(String reason, Object... arguments)
A garbage collection cycle is skipped for a specificreason
.void
updateStatus(String status)
The garbage collection entered a new phase e.g.void
warn(String message, Object... arguments)
Warning about a condition that might have adverse effects on the overall garbage collection process but does not prevent the process from running.
-
-
-
Field Detail
-
EMPTY
static final GCMonitor EMPTY
-
-
Method Detail
-
info
void info(String message, Object... arguments)
Informal notification on the progress of garbage collection.- Parameters:
message
- The message with {} place holders for thearguments
arguments
-
-
warn
void warn(String message, Object... arguments)
Warning about a condition that might have adverse effects on the overall garbage collection process but does not prevent the process from running.- Parameters:
message
- The message with {} place holders for thearguments
arguments
-
-
error
void error(String message, Exception exception)
An error caused the garbage collection process to terminate prematurely.- Parameters:
message
-exception
-
-
skipped
void skipped(String reason, Object... arguments)
A garbage collection cycle is skipped for a specificreason
.- Parameters:
reason
- The reason with {} place holders for thearguments
arguments
-
-
compacted
void compacted()
The compaction phase of the garbage collection process terminated successfully.
-
cleaned
void cleaned(long reclaimedSize, long currentSize)
The cleanup phase of the garbage collection process terminated successfully.- Parameters:
reclaimedSize
- number of bytes reclaimedcurrentSize
- number of bytes after garbage collection
-
updateStatus
void updateStatus(String status)
The garbage collection entered a new phase e.g. idle, estimation, etc.- Parameters:
status
- short summary of the GC phase
-
-