eu.id3.face

## Enum SubjectPosition

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

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

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

  Enumerates the positions of a subject in an image.

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant and Description
    `CORRECT` The position is correct.
    `TOO_CLOSE` The subject is too close.
    `TOO_FAR` The subject is too far.
    `TOO_HIGH` The subject is too high.
    `TOO_LEFT` The subject is too left.
    `TOO_LOW` The subject is too low.
    `TOO_RIGHT` The subject is too right.
    `UNDEFINED` The position is undefined.

  - ### Method Summary

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

    - #### UNDEFINED

          public static final SubjectPosition UNDEFINED

      The position is undefined.

    - #### CORRECT

          public static final SubjectPosition CORRECT

      The position is correct.

    - #### TOO_CLOSE

          public static final SubjectPosition TOO_CLOSE

      The subject is too close.

    - #### TOO_FAR

          public static final SubjectPosition TOO_FAR

      The subject is too far.

    - #### TOO_LEFT

          public static final SubjectPosition TOO_LEFT

      The subject is too left.

    - #### TOO_RIGHT

          public static final SubjectPosition TOO_RIGHT

      The subject is too right.

    - #### TOO_HIGH

          public static final SubjectPosition TOO_HIGH

      The subject is too high.

    - #### TOO_LOW

          public static final SubjectPosition TOO_LOW

      The subject is too low.

  - ### Method Detail

    - #### values

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

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

    - #### valueOf

          public static SubjectPosition 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 SubjectPosition fromValue(int value)

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

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