Package com.geniusscansdk.core

Enum FilterType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<FilterType>
    public enum FilterType
extends java.lang.Enum<FilterType>
    The different possible filters that can be applied to an image.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BLACK_WHITE
      The black and white filter results in a mostly black and white image but gray levels are used for antialiasing.
      COLOR
      Turns the background white but preserves the color.
      MONOCHROME
      The resulting image only contains Black and White filter.
      NONE
      The image is left unchanged.
      PHOTO
      This filter is best for documents with mainly graphic parts and little text.

    • Method Summary

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

      • NONE

        public static final FilterType NONE
        The image is left unchanged.

      • BLACK_WHITE

        public static final FilterType BLACK_WHITE
        The black and white filter results in a mostly black and white image but gray levels are used for antialiasing. The background is turned white.

      • PHOTO

        public static final FilterType PHOTO
        This filter is best for documents with mainly graphic parts and little text.

      • COLOR

        public static final FilterType COLOR
        Turns the background white but preserves the color.

      • MONOCHROME

        public static final FilterType MONOCHROME
        The resulting image only contains Black and White filter. This filter is ideal when saving the resulting image as PNG to minimize the file size.

    • Method Detail

      • values

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

      • valueOf

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

      • getCode

        public int getCode()