Package com.github.romankh3.image.comparison.model

Enum ImageComparisonState

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ImageComparisonState>
    public enum ImageComparisonState
extends java.lang.Enum<ImageComparisonState>
    Enum for telling the result of the Comparison. For example MATCH - means that the images are equal.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      MATCH
      Result state of the images, where images are equal, e.g.
      MISMATCH
      Result state of the comparison, where mismatch of the images.
      SIZE_MISMATCH
      Result state of the comparison, where mismatch of the image sizes.

    • Method Summary

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

      • SIZE_MISMATCH

        public static final ImageComparisonState SIZE_MISMATCH
        Result state of the comparison, where mismatch of the image sizes.

      • MISMATCH

        public static final ImageComparisonState MISMATCH
        Result state of the comparison, where mismatch of the images.

      • MATCH

        public static final ImageComparisonState MATCH
        Result state of the images, where images are equal, e.g. match.

    • Method Detail

      • values

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

      • valueOf

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