Interface RdfCanonTicker

  • All Known Implementing Classes:
    RdfCanonTimeTicker
    Functional Interface:
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

    @FunctionalInterface
    public interface RdfCanonTicker
    Functional interface that enables controlled interruption of the RDF dataset canonicalization process based on user-defined criteria.

    An implementation of RdfCanonTicker can be provided to monitor progress or impose constraints such as timeouts, processing limits, or other custom stopping conditions during canonicalization.

    The tick() method is invoked periodically during the execution of RdfCanon.provide(com.apicatalog.rdf.api.RdfQuadConsumer). If tick() throws an IllegalStateException, the canonicalization process will terminate prematurely.

    This mechanism is useful for applications that require fine-grained control over resource usage or need to abort processing based on external factors.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void tick()
      Called periodically during RDF dataset canonicalization to determine whether the process should continue.
    • Method Detail

      • tick

        void tick()
           throws java.lang.IllegalStateException
        Called periodically during RDF dataset canonicalization to determine whether the process should continue.

        Implementations should throw IllegalStateException to interrupt the process when necessary (e.g., on timeout, exceeding a limit, or external cancellation).

        Throws:
        java.lang.IllegalStateException - if the canonicalization process should be aborted.