CaptchaEffect (Cyclos 4.16.19 Scripting API Documentation)

java.lang.Object
- java.lang.Enum<CaptchaEffect>
- - org.cyclos.model.system.configurations.CaptchaEffect

All Implemented Interfaces:

Serializable, Comparable<CaptchaEffect>, HasMessageKey
```
public enum CaptchaEffect
extends Enum<CaptchaEffect>
implements HasMessageKey
```
The effect applied to the internally generated CAPTCHA image to make it harder to OCR

Enum Constant Summary

Enum Constants
Enum Constant Description

FISH_EYE
Fish-eye

SHADOW
Shadow

WATER
Water

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MessageKey`	`getMessageKey()`
`static CaptchaEffect`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static CaptchaEffect[]`	`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
  - SHADOW
```
public static final CaptchaEffect SHADOW
```
    Shadow
  - FISH_EYE
```
public static final CaptchaEffect FISH_EYE
```
    Fish-eye
  - WATER
```
public static final CaptchaEffect WATER
```
    Water
- Method Detail
  - values
```
public static CaptchaEffect[] 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 (CaptchaEffect c : CaptchaEffect.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static CaptchaEffect 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
  - getMessageKey
```
public MessageKey getMessageKey()
```
    Specified by:
    
    getMessageKey in interface HasMessageKey