FpeOptionsBasic (sdkms-client 4.19.2244 API)

java.lang.Object
- com.fortanix.sdkms.v1.model.FpeOptionsBasic

public class FpeOptionsBasic
extends Object

Basic FPE-specific options.

Constructor Summary

Constructors
Constructor and Description

FpeOptionsBasic()

Constructors
Constructor and Description
`FpeOptionsBasic()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FpeOptionsBasic`	`addMaskItem(Integer maskItem)`
`FpeOptionsBasic`	`addPreserveItem(Integer preserveItem)`
`boolean`	`equals(Object o)`
`Boolean`	`getLuhnCheck()` Whether encrypted/decrypted data should satisfy LUHN checksum formula.
`List<Integer>`	`getMask()` The list of indices of characters to be masked while performing masked decryption.
`Integer`	`getMaxLength()` The maximum allowed length for the input data.
`Integer`	`getMinLength()` The minimum allowed length for the input data.
`String`	`getName()` The user-friendly name for the data type that represents the input data.
`List<Integer>`	`getPreserve()` The list of indices of characters to be preserved while performing encryption/decryption.
`Integer`	`getRadix()` The base for input data.
`int`	`hashCode()`
`FpeOptionsBasic`	`luhnCheck(Boolean luhnCheck)`
`FpeOptionsBasic`	`mask(List<Integer> mask)`
`FpeOptionsBasic`	`maxLength(Integer maxLength)`
`FpeOptionsBasic`	`minLength(Integer minLength)`
`FpeOptionsBasic`	`name(String name)`
`FpeOptionsBasic`	`preserve(List<Integer> preserve)`
`FpeOptionsBasic`	`radix(Integer radix)`
`void`	`setLuhnCheck(Boolean luhnCheck)`
`void`	`setMask(List<Integer> mask)`
`void`	`setMaxLength(Integer maxLength)`
`void`	`setMinLength(Integer minLength)`
`void`	`setName(String name)`
`void`	`setPreserve(List<Integer> preserve)`
`void`	`setRadix(Integer radix)`
`String`	`toString()`

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

- Constructor Detail
  - FpeOptionsBasic
```
public FpeOptionsBasic()
```
- Method Detail
  - radix
```
public FpeOptionsBasic radix(Integer radix)
```
  - getRadix
```
public Integer getRadix()
```
    The base for input data. The radix should be a number from 2 to 36, inclusive. Each radix corresponds to a subset of ASCII alphanumeric characters (with all letters being uppercase). For instance, a radix of 10 corresponds to a character set consisting of the digits from 0 to 9, while a character set of 16 corresponds to a character set consisting of all hexadecimal digits (with letters A-F being uppercase).
    
    Returns:
    
    radix
  - setRadix
```
public void setRadix(Integer radix)
```
  - minLength
```
public FpeOptionsBasic minLength(Integer minLength)
```
  - getMinLength
```
public Integer getMinLength()
```
    The minimum allowed length for the input data. If not specified, as a default, the min length will be set to the smallest value that allows the condition radix^min_length >= 100 to be satisfied.
    
    Returns:
    
    minLength
  - setMinLength
```
public void setMinLength(Integer minLength)
```
  - maxLength
```
public FpeOptionsBasic maxLength(Integer maxLength)
```
  - getMaxLength
```
public Integer getMaxLength()
```
    The maximum allowed length for the input data. If not specified, a default max length of 2^16 will be used.
    
    Returns:
    
    maxLength
  - setMaxLength
```
public void setMaxLength(Integer maxLength)
```
  - preserve
```
public FpeOptionsBasic preserve(List<Integer> preserve)
```
  - addPreserveItem
```
public FpeOptionsBasic addPreserveItem(Integer preserveItem)
```
  - getPreserve
```
public List<Integer> getPreserve()
```
    The list of indices of characters to be preserved while performing encryption/decryption. Indices are Python-like, where negative indices index from the back of the token, with -1 referring to the end of the token. It is an error to specify indices greater than (min_length - 1) or less than (-min_length).
    
    Returns:
    
    preserve
  - setPreserve
```
public void setPreserve(List<Integer> preserve)
```
  - mask
```
public FpeOptionsBasic mask(List<Integer> mask)
```
  - addMaskItem
```
public FpeOptionsBasic addMaskItem(Integer maskItem)
```
  - getMask
```
public List<Integer> getMask()
```
    The list of indices of characters to be masked while performing masked decryption. Indices are Python-like, where negative indices index from the back of the token, with -1 referring to the end of the token. It is an error to specify indices greater than (min_length - 1) or less than (-min_length).
    
    Returns:
    
    mask
  - setMask
```
public void setMask(List<Integer> mask)
```
  - luhnCheck
```
public FpeOptionsBasic luhnCheck(Boolean luhnCheck)
```
  - getLuhnCheck
```
public Boolean getLuhnCheck()
```
    Whether encrypted/decrypted data should satisfy LUHN checksum formula.
    
    Returns:
    
    luhnCheck
  - setLuhnCheck
```
public void setLuhnCheck(Boolean luhnCheck)
```
  - name
```
public FpeOptionsBasic name(String name)
```
  - getName
```
public String getName()
```
    The user-friendly name for the data type that represents the input data.
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class FpeOptionsBasic

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FpeOptionsBasic

Method Detail

radix

getRadix

setRadix

minLength

getMinLength

setMinLength

maxLength

getMaxLength

setMaxLength

preserve

addPreserveItem

getPreserve

setPreserve

mask

addMaskItem

getMask

setMask

luhnCheck

getLuhnCheck

setLuhnCheck

name

getName

setName

equals

hashCode

toString