GradientDetectMethod | DME Component Libraries for Java 2024 r3

java.lang.Object
- java.lang.Enum<GradientDetectMethod>
- - agi.foundation.graphics.imaging.GradientDetectMethod

All Implemented Interfaces:

Enumeration, Serializable, Comparable<GradientDetectMethod>
```
public enum GradientDetectMethod
extends Enum<GradientDetectMethod>
implements Enumeration
```
The method used to detect gradients in a raster. Gradient detection is commonly referred to as embossing.

See Also:

GradientDetectMethod

Enum Constant Summary

Enum Constants
Enum Constant and Description
`EAST` Detects east gradients.
`NORTH` Detects north gradients.
`NORTH_EAST` Detects north east gradients.
`NORTH_WEST` Detects north west gradients.
`SOUTH` Detects south gradients.
`SOUTH_EAST` Detects south east gradients.
`SOUTH_WEST` Detects south west gradients.
`WEST` Detects west gradients.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GradientDetectMethod`	`getDefault()` Get the enum constant that is considered to be the default.
`static GradientDetectMethod`	`getFromValue(int value)` Get the enum constant that is associated with the given numeric value.
`int`	`getValue()` Get the numeric value associated with this enum constant.
`static GradientDetectMethod`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static GradientDetectMethod[]`	`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
  - EAST
```
public static final GradientDetectMethod EAST
```
    Detects east gradients.
  - NORTH
```
public static final GradientDetectMethod NORTH
```
    Detects north gradients.
  - WEST
```
public static final GradientDetectMethod WEST
```
    Detects west gradients.
  - SOUTH
```
public static final GradientDetectMethod SOUTH
```
    Detects south gradients.
  - NORTH_EAST
```
public static final GradientDetectMethod NORTH_EAST
```
    Detects north east gradients.
  - NORTH_WEST
```
public static final GradientDetectMethod NORTH_WEST
```
    Detects north west gradients.
  - SOUTH_EAST
```
public static final GradientDetectMethod SOUTH_EAST
```
    Detects south east gradients.
  - SOUTH_WEST
```
public static final GradientDetectMethod SOUTH_WEST
```
    Detects south west gradients.
- Method Detail
  - values
```
public static GradientDetectMethod[] 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 (GradientDetectMethod c : GradientDetectMethod.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static GradientDetectMethod valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getValue
```
public int getValue()
```
    Get the numeric value associated with this enum constant.
    
    Specified by:
    
    getValue in interface Enumeration
    
    Returns:
    
    A numeric value.
  - getFromValue
```
@Nonnull
public static GradientDetectMethod getFromValue(int value)
```
    Get the enum constant that is associated with the given numeric value.
    
    Parameters:
    
    value - a numeric value.
    
    Returns:
    
    The enum constant associated with value.
  - getDefault
```
@Nonnull
public static GradientDetectMethod getDefault()
```
    Get the enum constant that is considered to be the default.
    
    Returns:
    
    The default enum constant.

Enum GradientDetectMethod

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

EAST

NORTH

WEST

SOUTH

NORTH_EAST

NORTH_WEST

SOUTH_EAST

SOUTH_WEST

Method Detail

values

valueOf

getValue

getFromValue

getDefault