io.scanbot.sdk.tiff.model

Class TIFFImageWriterUserDefinedField

io.scanbot.sdk.tiff.model.TIFFImageWriterUserDefinedField

public class TIFFImageWriterUserDefinedField

Class used to describe user-defined TIFF field.

Field Detail

Companion

public static io.scanbot.sdk.tiff.model.TIFFImageWriterUserDefinedField.Companion Companion

Method Detail

getFieldName

@NotNull
public java.lang.String getFieldName()

Returns:

Field name.

getFieldTag

public int getFieldTag()

Returns:

Field numeric tag.

getFieldType

@NotNull
public TIFFImageWriterUserDefinedFieldType getFieldType()

Returns:

Field type enum TIFFImageWriterUserDefinedFieldType.

getIntValue

@Nullable
public java.lang.Integer getIntValue()

Returns:

numeric value of the field, if field type is TIFFImageWriterUserDefinedFieldType.NumericInteger. Returns null otherwise.

getDoubleValue

@Nullable
public java.lang.Double getDoubleValue()

Returns:

numeric value of the field, if field type is TIFFImageWriterUserDefinedFieldType.NumericDouble. Returns null otherwise.

getStringValue

@Nullable
public java.lang.String getStringValue()

Returns:

string value of the field, if field type is TIFFImageWriterUserDefinedFieldType.String. Returns null otherwise.

fieldWithIntValue

@JvmStatic
 @NotNull
public static TIFFImageWriterUserDefinedField fieldWithIntValue(int value,
                                                                                     @NotNull
                                                                                     java.lang.String fieldName,
                                                                                     int fieldTag)

Generate new field with given parameters.

Parameters:

value - Field numeric Integer value.

fieldName - Field name.

fieldTag - Field tag. Please refer to TIFF documentation regarding reserved tag numbers and their field types.

Returns:

Generated field.

fieldWithDoubleValue

@JvmStatic
 @NotNull
public static TIFFImageWriterUserDefinedField fieldWithDoubleValue(double value,
                                                                                        @NotNull
                                                                                        java.lang.String fieldName,
                                                                                        int fieldTag)

Generate new field with given parameters.

Parameters:

value - Field numeric Double value.

fieldName - Field name.

fieldTag - Field tag. Please refer to TIFF documentation regarding reserved tag numbers and their field types.

Returns:

Generated field.

fieldWithStringValue

@JvmStatic
 @NotNull
public static TIFFImageWriterUserDefinedField fieldWithStringValue(@NotNull
                                                                                        java.lang.String value,
                                                                                        @NotNull
                                                                                        java.lang.String fieldName,
                                                                                        int fieldTag)

Generate new field with given parameters.

Parameters:

value - Field string value.

fieldName - Field name.

fieldTag - Field tag. Please refer to TIFF documentation regarding reserved tag numbers and their field types.

Returns:

Generated field.