Package io.micronaut.coherence.annotation

Enum CommitStrategy

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<CommitStrategy>
    public enum CommitStrategy
extends java.lang.Enum<CommitStrategy>

    An enum representing different strategies for committing positions in a Coherence topic when using CoherenceTopicListener.

    To track messages that have been consumed, Coherence allows committing positions at a frequency desired by the developer.

    Depending on requirements you may wish the commit more or less frequently and you may not care whether the commit was successful or not. This enum allows configuring a range of policies for a Coherence topic subscriber from leaving it down to the client to synchronously commit (with SYNC) or asynchronously commit (with ASYNC) after each message is consumed, through to manually handling commits (with MANUAL).

    Since:
    1.0
    Author:
    Jonathan Knight

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ASYNC
      Asynchronously commit using Subscriber.Element.commitAsync() after each messages is processed.
      MANUAL
      Do not commit messages.
      SYNC
      Synchronously commit using Subscriber.Element.commit() after each messages is processed.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static CommitStrategy valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static CommitStrategy[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • MANUAL

        public static final CommitStrategy MANUAL
        Do not commit messages. In this case the subscriber method should accept an argument that is the Subscriber.Element itself and call Subscriber.Element.commit() or Subscriber.Element.commitAsync() to commit the received element.

      • SYNC

        public static final CommitStrategy SYNC
        Synchronously commit using Subscriber.Element.commit() after each messages is processed.

      • ASYNC

        public static final CommitStrategy ASYNC
        Asynchronously commit using Subscriber.Element.commitAsync() after each messages is processed.

    • Method Detail

      • values

        public static CommitStrategy[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (CommitStrategy c : CommitStrategy.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static CommitStrategy valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null