Package org.apache.jackrabbit.oak.spi.gc

Class DelegatingGCMonitor

  • All Implemented Interfaces:
    GCMonitor
    public class DelegatingGCMonitor
extends java.lang.Object
implements GCMonitor
    This GCMonitor implementation simply delegates all its call to registered monitors.

    • Nested Class Summary

    • Field Summary

      • Fields inherited from interface org.apache.jackrabbit.oak.spi.gc.GCMonitor

        EMPTY

    • Constructor Summary

      Constructors 
      Constructor Description
      DelegatingGCMonitor()
      New instance without any delegate.
      DelegatingGCMonitor​(@NotNull java.util.Collection<? extends GCMonitor> gcMonitors)
      New instance with an initial set of delegates (which cannot be unregistered).

    • Method Summary

      All Methods Instance Methods Concrete 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​(java.lang.String message, java.lang.Exception exception)
      An error caused the garbage collection process to terminate prematurely.
      void info​(java.lang.String message, java.lang.Object... arguments)
      Informal notification on the progress of garbage collection.
      Registration registerGCMonitor​(@NotNull GCMonitor gcMonitor)
      Register a GCMonitor.
      void skipped​(java.lang.String reason, java.lang.Object... arguments)
      A garbage collection cycle is skipped for a specific reason.
      void updateStatus​(java.lang.String status)
      The garbage collection entered a new phase e.g.
      void warn​(java.lang.String message, java.lang.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.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • DelegatingGCMonitor

        public DelegatingGCMonitor​(@NotNull
                           @NotNull java.util.Collection<? extends GCMonitor> gcMonitors)
        New instance with an initial set of delegates (which cannot be unregistered).
        Parameters:
        gcMonitors -

      • DelegatingGCMonitor

        public DelegatingGCMonitor()
        New instance without any delegate.

    • Method Detail

      • registerGCMonitor

        public Registration registerGCMonitor​(@NotNull
                                      @NotNull GCMonitor gcMonitor)
        Register a GCMonitor.
        Parameters:
        gcMonitor -
        Returns:
        a Registration instance, which removes the registered GCMonitor instance when called.

      • info

        public void info​(java.lang.String message,
                 java.lang.Object... arguments)
        Description copied from interface: GCMonitor
        Informal notification on the progress of garbage collection.
        Specified by:
        info in interface GCMonitor
        Parameters:
        message - The message with {} place holders for the arguments

      • warn

        public void warn​(java.lang.String message,
                 java.lang.Object... arguments)
        Description copied from interface: GCMonitor
        Warning about a condition that might have adverse effects on the overall garbage collection process but does not prevent the process from running.
        Specified by:
        warn in interface GCMonitor
        Parameters:
        message - The message with {} place holders for the arguments

      • error

        public void error​(java.lang.String message,
                  java.lang.Exception exception)
        Description copied from interface: GCMonitor
        An error caused the garbage collection process to terminate prematurely.
        Specified by:
        error in interface GCMonitor

      • skipped

        public void skipped​(java.lang.String reason,
                    java.lang.Object... arguments)
        Description copied from interface: GCMonitor
        A garbage collection cycle is skipped for a specific reason.
        Specified by:
        skipped in interface GCMonitor
        Parameters:
        reason - The reason with {} place holders for the arguments

      • compacted

        public void compacted()
        Description copied from interface: GCMonitor
        The compaction phase of the garbage collection process terminated successfully.
        Specified by:
        compacted in interface GCMonitor

      • cleaned

        public void cleaned​(long reclaimedSize,
                    long currentSize)
        Description copied from interface: GCMonitor
        The cleanup phase of the garbage collection process terminated successfully.
        Specified by:
        cleaned in interface GCMonitor
        Parameters:
        reclaimedSize - number of bytes reclaimed
        currentSize - number of bytes after garbage collection

      • updateStatus

        public void updateStatus​(java.lang.String status)
        Description copied from interface: GCMonitor
        The garbage collection entered a new phase e.g. idle, estimation, etc.
        Specified by:
        updateStatus in interface GCMonitor
        Parameters:
        status - short summary of the GC phase