Package org.apache.jackrabbit.oak.spi.gc
Interface GCMonitor
- All Known Implementing Classes:
DelegatingGCMonitor
,FileStoreGCMonitor
,GCMonitor.Empty
,GCMonitorTracker
,LoggingGCMonitor
public interface GCMonitor
GCMonitor
instance are used to monitor garbage collection.
Instances of GCMonitor
are registered to the Whiteboard
to receive notifications regarding garbage collection.-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
cleaned
(long reclaimedSize, long currentSize) The cleanup phase of the garbage collection process terminated successfully.void
The compaction phase of the garbage collection process terminated successfully.void
An error caused the garbage collection process to terminate prematurely.void
Informal notification on the progress of garbage collection.void
A garbage collection cycle is skipped for a specificreason
.void
updateStatus
(String status) The garbage collection entered a new phase e.g.void
Warning about a condition that might have adverse effects on the overall garbage collection process but does not prevent the process from running.
-
Field Details
-
EMPTY
-
-
Method Details
-
info
Informal notification on the progress of garbage collection.- Parameters:
message
- The message with {} place holders for thearguments
arguments
-
-
warn
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
An error caused the garbage collection process to terminate prematurely.- Parameters:
message
-exception
-
-
skipped
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
The garbage collection entered a new phase e.g. idle, estimation, etc.- Parameters:
status
- short summary of the GC phase
-