Package io.ocfl.api

Enum Class OcflOption

java.lang.Object
java.lang.Enum<OcflOption>
io.ocfl.api.OcflOption
All Implemented Interfaces:
Serializable, Comparable<OcflOption>, java.lang.constant.Constable
public enum OcflOption extends Enum<OcflOption>

  • Enum Constant Details

    • OVERWRITE

      public static final OcflOption OVERWRITE
      Instructs an update operation to overwrite existing files in an object.

    • MOVE_SOURCE

      public static final OcflOption MOVE_SOURCE
      Instructs an update operation to move files into the repository instead of copying them.

    • NO_VALIDATION

      public static final OcflOption NO_VALIDATION
      Disables validations that ensure the integrity of OCFL objects

  • Method Details

    • values

      public static OcflOption[] 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 OcflOption 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

    • toSet

      public static Set<OcflOption> toSet(OcflOption... options)
      Transforms a varargs of options into a set
      Parameters:
      options - options
      Returns:
      set of options

    • contains

      public static boolean contains(OcflOption test, OcflOption... options)
      Returns true if the set of options contains the specified option
      Parameters:
      test - the option to look for
      options - the set of options
      Returns:
      true if the specified option is in the set