Package com.norconex.committer.core3

Class CommitterContext

java.lang.Object
com.norconex.committer.core3.CommitterContext
public final class CommitterContext extends Object
Holds data defined outside a committer but useful or required for the committer execution.
Since:
3.0.0
Author:
Pascal Essiembre

  • Method Details

    • getEventManager

      public EventManager getEventManager()
      Gets the event manager used to fire committer events.
      Returns:
      event manager

    • getWorkDir

      public Path getWorkDir()
      Gets a unique working directory for a committer (if one is needed).
      Returns:
      working directory (never null)

    • getStreamFactory

      public CachedStreamFactory getStreamFactory()
      Gets the cached stream factory used by committers.
      Returns:
      cached stream factory

    • withEventManager

      public CommitterContext withEventManager(EventManager eventManager)
      Creates a copy of this context with a different event manager.
      Parameters:
      eventManager - event manager to use
      Returns:
      new context instance

    • withWorkdir

      public CommitterContext withWorkdir(Path workDir)
      Creates a copy of this context with a different working directory.
      Parameters:
      workDir - working directory to use
      Returns:
      new context instance

    • withStreamFactory

      public CommitterContext withStreamFactory(CachedStreamFactory streamFactory)
      Creates a copy of this context with a different stream factory.
      Parameters:
      streamFactory - stream factory to use
      Returns:
      new context instance

    • builder

      public static CommitterContext.Builder builder()
      Creates a builder for CommitterContext.
      Returns:
      context builder

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object