ImageFileFormat (TIM API v3.38.0 - Java Documentation)

java.lang.Object
- java.lang.Enum<ImageFileFormat>
- - com.six.timapi.constants.ImageFileFormat

All Implemented Interfaces:

Serializable, Comparable<ImageFileFormat>
```
public enum ImageFileFormat
extends Enum<ImageFileFormat>
```
Defines the file format of the signature image.

This field can either be used as attribute in the tag to define the file format of the signature image that is wished to be returned, or in the to specify the file format of the signature image that has actually been returned from the terminal.

The following values are valid:

Specification: retail.

Enum Constant Summary

Enum Constants
Enum Constant Description

BMP
BMP format.

JPEG
JPEG format.

PNG
PNG format.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static ImageFileFormat`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static ImageFileFormat[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - JPEG
```
public static final ImageFileFormat JPEG
```
    JPEG format.
    
    Specification: retail.
  - PNG
```
public static final ImageFileFormat PNG
```
    PNG format.
    
    Specification: retail.
  - BMP
```
public static final ImageFileFormat BMP
```
    BMP format.
    
    Specification: retail.
- Method Detail
  - values
```
public static ImageFileFormat[] 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 (ImageFileFormat c : ImageFileFormat.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ImageFileFormat 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