Package io.datareplication.model.feed

Enum OperationType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<OperationType>
    public enum OperationType
extends java.lang.Enum<OperationType>
    A feed entity's operation type. These correspond to HTTP verbs. They have no impact on how an entity is actually processed by this library so any semantic interpretation happens outside the consumer. As such, the descriptions of behaviour for the different types are only informational: the exact semantics of how to use these values and how they have to be interpreted by consumers are left up to the provider of the feed to define.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DELETE
      This entity represents the deletion of a resource.
      PATCH
      This entity represents a partial update of some resource.
      PUT
      This entity represents a complete replacement of some resource.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String toString()  
      static OperationType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static OperationType[] 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, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • PUT

        public static final OperationType PUT
        This entity represents a complete replacement of some resource. The entity body is expected to contain a reference to the resource and all its data. The state of the resource after processing this entity should not depend on its previous state.

      • DELETE

        public static final OperationType DELETE
        This entity represents the deletion of a resource. After processing this entity, the resource should not exist regardless of its previous state.

      • PATCH

        public static final OperationType PATCH
        This entity represents a partial update of some resource. The entity body should contain a reference to the resource and the subset of the data that should be changed. PATCH updates may still be idempotent but don't necessarily have to be.

    • Method Detail

      • values

        public static OperationType[] 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 (OperationType c : OperationType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static OperationType 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

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<OperationType>