Package io.scanbot.sdk.image

Enum PathLoadMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<PathLoadMode>
    public enum PathLoadMode
extends java.lang.Enum<PathLoadMode>
    Image Ref Path Load Mode.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      EAGER
      Image is immediately loaded into memory.
      LAZY
      Image is loaded into memory the first time it's requested.
      LAZY_WITH_COPY
      Image is loaded into memory the first time it's requested.

    • Method Summary

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

      • EAGER

        public static final PathLoadMode EAGER
        Image is immediately loaded into memory.

      • LAZY

        public static final PathLoadMode LAZY
        Image is loaded into memory the first time it's requested. Specified path must exist at the time of loading.

      • LAZY_WITH_COPY

        public static final PathLoadMode LAZY_WITH_COPY
        Image is loaded into memory the first time it's requested. Specified path is copied into internal directory and so isn't required to exist at the time of loading.

    • Method Detail

      • values

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

      • valueOf

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