Package nl.datasteel.crudcraft.annotations

Enum Class CrudEndpoint

java.lang.Object
java.lang.Enum<CrudEndpoint>
nl.datasteel.crudcraft.annotations.CrudEndpoint
All Implemented Interfaces:
Serializable, Comparable<CrudEndpoint>, Constable
public enum CrudEndpoint extends Enum<CrudEndpoint>
Enumeration of CRUD (Create, Read, Update, Delete) endpoints.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    BULK_CREATE
    Creates multiple resources in a single request.
    BULK_DELETE
    Deletes multiple resources in a single request.
    BULK_FIND_BY_IDS
    Finds multiple resources by their IDs in a single request.
    BULK_PATCH
    Partially updates multiple resources in a single request.
    BULK_UPDATE
    Updates multiple resources in a single request.
    BULK_UPSERT
    Creates or updates multiple resources in a single request.
    COUNT
    Counts the total number of resources that match the criteria.
    DELETE
    Deletes a resource by its ID.
    EXISTS
    Checks if a resource exists by its ID.
    EXPORT
    Exports resources in a specific format, based on specified criteria.
    GET_ALL
    Gets all resources, with pagination and sorting options.
    GET_ALL_REF
    Gets all reference versions of resources, with pagination and sorting options.
    GET_ONE
    Gets a single resource by its ID.
    PATCH
    Partially updates an existing resource by its ID.
    POST
    Creates a new resource.
    PUT
    Updates an existing resource by its ID.
    SEARCH
    Searches for resources based on specific criteria.
    VALIDATE
    Validates a resource without creating or updating it.

  • Method Summary

    Modifier and Type
    Method
    Description
    static CrudEndpoint
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static CrudEndpoint[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • GET_ALL

      public static final CrudEndpoint GET_ALL
      Gets all resources, with pagination and sorting options.

    • GET_ALL_REF

      public static final CrudEndpoint GET_ALL_REF
      Gets all reference versions of resources, with pagination and sorting options.

    • GET_ONE

      public static final CrudEndpoint GET_ONE
      Gets a single resource by its ID.

    • POST

      public static final CrudEndpoint POST
      Creates a new resource.

    • PUT

      public static final CrudEndpoint PUT
      Updates an existing resource by its ID.

    • PATCH

      public static final CrudEndpoint PATCH
      Partially updates an existing resource by its ID.

    • DELETE

      public static final CrudEndpoint DELETE
      Deletes a resource by its ID.

    • BULK_CREATE

      public static final CrudEndpoint BULK_CREATE
      Creates multiple resources in a single request.

    • BULK_UPDATE

      public static final CrudEndpoint BULK_UPDATE
      Updates multiple resources in a single request.

    • BULK_PATCH

      public static final CrudEndpoint BULK_PATCH
      Partially updates multiple resources in a single request.

    • BULK_UPSERT

      public static final CrudEndpoint BULK_UPSERT
      Creates or updates multiple resources in a single request.

    • BULK_DELETE

      public static final CrudEndpoint BULK_DELETE
      Deletes multiple resources in a single request.

    • BULK_FIND_BY_IDS

      public static final CrudEndpoint BULK_FIND_BY_IDS
      Finds multiple resources by their IDs in a single request.

    • EXISTS

      public static final CrudEndpoint EXISTS
      Checks if a resource exists by its ID.

    • COUNT

      public static final CrudEndpoint COUNT
      Counts the total number of resources that match the criteria.

    • VALIDATE

      public static final CrudEndpoint VALIDATE
      Validates a resource without creating or updating it.

    • EXPORT

      public static final CrudEndpoint EXPORT
      Exports resources in a specific format, based on specified criteria.

  • Method Details

    • values

      public static CrudEndpoint[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static CrudEndpoint valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null