Interface SinkWrapperFactory

All Known Implementing Classes:
BufferingSinkProxyFactory, CreateAnchorsForIndexEntriesFactory, UniqueAnchorNamesValidatorFactory
public interface SinkWrapperFactory
A factory for a sink wrapping another sink. The delegate may either be the original sink or another wrapper.
Since:
2.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    Sink
    createWrapper(Sink sink)
    By default all wrappers just delegate each method to the wrapped sink's method.
    int
    getPriority()
    Determines the order of sink wrappers.

  • Method Details

    • createWrapper

      Sink createWrapper(Sink sink)
      By default all wrappers just delegate each method to the wrapped sink's method. For certain Sink methods the wrapper may modify the sink before/after or instead of calling the delegate's method.
      Parameters:
      sink - the delegate
      Returns:
      a new sink wrapping the given one

    • getPriority

      int getPriority()
      Determines the order of sink wrappers. The wrapper factory with the highest priority is called first.
      Returns:
      the priority of this factory