eu.id3.face

## Enum ImageError

- java.lang.Object
- - java.lang.Enum<ImageError>
  - - eu.id3.face.ImageError

- All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ImageError>

      public enum ImageError
      extends java.lang.Enum<ImageError>

  Enumerates possible error codes related to image management.

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant and Description
    `BACKEND_ERROR` TODO
    `BASE` Base error code for Image module.
    `FUNCTION_NOT_IMPLEMENTED` Function not implemented.
    `IMAGE_SIZE_MISMATCH` The image sizes are not compatible for the requested operation.
    `INSUFFICIENT_BUFFER` The given buffer is too small.
    `INVALID_HANDLE` The handle is invalid.
    `INVALID_PARAMETER` The parameter is invalid.
    `INVALID_PIXEL_FORMAT` The required pixel format is not correct.
    `KEY_ALREADY_EXISTS` The given key is already used in the dictionary.
    `KEY_NOT_FOUND` The given key is not present in the dictionary.
    `MINIMUM` Minimum error code for Image module.
    `OBJECT_DOES_NOT_EXIST` The requested object does not exist; a 'null' should be returned if possible.
    `PIXEL_FORMAT_MISMATCH` The pixel formats are not compatible.
    `PYTHON_MODULE` An error as occured during python module initialization.
    `SUCCESS` No error.

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static ImageError` | `fromValue(int value)` Creates an enumeration value from int.
    `int` | `getValue()` Gets the enumeration value as int.
    `static ImageError` | `valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
    `static ImageError[]` | `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

    - #### SUCCESS

          public static final ImageError SUCCESS

      No error.

    - #### INSUFFICIENT_BUFFER

          public static final ImageError INSUFFICIENT_BUFFER

      The given buffer is too small.

    - #### OBJECT_DOES_NOT_EXIST

          public static final ImageError OBJECT_DOES_NOT_EXIST

      The requested object does not exist; a 'null' should be returned if possible.

    - #### BASE

          public static final ImageError BASE

      Base error code for Image module.

    - #### MINIMUM

          public static final ImageError MINIMUM

      Minimum error code for Image module.

    - #### INVALID_HANDLE

          public static final ImageError INVALID_HANDLE

      The handle is invalid.

    - #### INVALID_PARAMETER

          public static final ImageError INVALID_PARAMETER

      The parameter is invalid.

    - #### IMAGE_SIZE_MISMATCH

          public static final ImageError IMAGE_SIZE_MISMATCH

      The image sizes are not compatible for the requested operation.

    - #### PIXEL_FORMAT_MISMATCH

          public static final ImageError PIXEL_FORMAT_MISMATCH

      The pixel formats are not compatible.

    - #### KEY_ALREADY_EXISTS

          public static final ImageError KEY_ALREADY_EXISTS

      The given key is already used in the dictionary. Multiple values per key is not supported.

    - #### KEY_NOT_FOUND

          public static final ImageError KEY_NOT_FOUND

      The given key is not present in the dictionary.

    - #### INVALID_PIXEL_FORMAT

          public static final ImageError INVALID_PIXEL_FORMAT

      The required pixel format is not correct.

    - #### PYTHON_MODULE

          public static final ImageError PYTHON_MODULE

      An error as occured during python module initialization.

    - #### FUNCTION_NOT_IMPLEMENTED

          public static final ImageError FUNCTION_NOT_IMPLEMENTED

      Function not implemented.

    - #### BACKEND_ERROR

          public static final ImageError BACKEND_ERROR

      TODO

  - ### Method Detail

    - #### values

          public static ImageError[] 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 (ImageError c : ImageError.values())
              System.out.println(c);

      Returns:
        an array containing the constants of this enum type, in the order they are declared

    - #### valueOf

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

    - #### getValue

          public int getValue()

      Gets the enumeration value as int.
      Returns:
        The value.

    - #### fromValue

          public static ImageError fromValue(int value)

      Creates an enumeration value from int.
      Parameters:
        `value` - The int value.
      Returns:
        The created ImageError.

Copyright © id3 Technologies. All rights reserved. eu.id3.face