Package io.scanbot.sdk.image

Enum ImageSourceType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ImageSourceType>
    public enum ImageSourceType
extends java.lang.Enum<ImageSourceType>
    The type of source which originated the underlying image.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      API
      ImageRef was created by a call to an SDK feature, such as a scanner, image processor, etc.
      BUFFER
      ImageRef was created from an encoded buffer.
      CAMERA
      ImageRef was created from data from the camera.
      FILE
      ImageRef was created from a file.
      OTHER
      ImageRef was created from another type, e.g.
      PLATFORM_IMAGE
      ImageRef was created from a platform image, e.g.

    • Method Summary

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

      • API

        public static final ImageSourceType API
        ImageRef was created by a call to an SDK feature, such as a scanner, image processor, etc.

      • PLATFORM_IMAGE

        public static final ImageSourceType PLATFORM_IMAGE
        ImageRef was created from a platform image, e.g. Bitmap on Android, UIImage on iOS.

      • CAMERA

        public static final ImageSourceType CAMERA
        ImageRef was created from data from the camera.

      • FILE

        public static final ImageSourceType FILE
        ImageRef was created from a file.

      • BUFFER

        public static final ImageSourceType BUFFER
        ImageRef was created from an encoded buffer.

      • OTHER

        public static final ImageSourceType OTHER
        ImageRef was created from another type, e.g. from custom loader.

    • Method Detail

      • values

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

      • valueOf

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