Package io.scanbot.sdk.image

Enum ColorConversion

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ColorConversion>
    public enum ColorConversion
extends java.lang.Enum<ColorConversion>
    Color conversion to apply during image loading.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ANY_COLOR
      Load image as 3-channel BGR if the source color space is color, otherwise as single-channel grayscale.
      COLOR
      Load image as 3-channel BGR.
      GRAY
      Load image as grayscale.
      UNCHANGED
      Load image as-is, preserving the alpha channel if it exists.

    • Method Summary

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

      • COLOR

        public static final ColorConversion COLOR
        Load image as 3-channel BGR.

      • ANY_COLOR

        public static final ColorConversion ANY_COLOR
        Load image as 3-channel BGR if the source color space is color, otherwise as single-channel grayscale. Alpha channel is discarded.

      • UNCHANGED

        public static final ColorConversion UNCHANGED
        Load image as-is, preserving the alpha channel if it exists.

    • Method Detail

      • values

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

      • valueOf

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